Context menu button, Ban Spammer #548

Mclilzee · 2024-06-13T09:44:47Z

Because

Phishing links spam is an ever-increasing occurrence on discord. The mod team have to keep banning these users with the same message so that they know how to contact us if they wish to rejoin the server.

This PR will automate that with a click of a button.

This PR

Adds context menu button to ban spam user
Logs the ban in the appropriate channel
Sends the user a contact information of why they were banned, and how to contact us once they recover their account if DM is not set to private.

Issue

Closes #504

Additional Information

Make sure to change the config.js moderationLog ID to the channel ID of your test server to see the log messages while testing.

There are currently some duplication of functions in some of the other services, I think it would be a good idea to move those to utils. Another duplication happen is with the tests, There is a buildInteraction function in test utils but that one is made for a specific purpose only, I would need to change it and refactor all the tests that calls it in order to generalize it to be used by these new tests. I didn't want this PR to be too big and include those refactors. So I included some create interaction mocks functions in the test files.

Let me know how would you like to proceed with the refactors.

Pull Request Requirements

I have thoroughly read and understand The Odin Project Contributing Guide
The title of this PR follows the location of change: brief description of change format, e.g. Callbacks command: Update verbiage
The Because section summarizes the reason for this PR
The This PR section has a bullet point list describing the changes in this PR
If this PR addresses an open issue, it is linked in the Issue section
If this PR adds new features or functionality, I have added new tests
If applicable, I have ensured all tests related to any command files included in this PR pass, and/or all snapshots are up to date

services/spam-ban/__snapshots__/spam-banning.service.test.js.snap

services/spam-ban/spam-banning.service.js

01zulfi · 2024-07-02T06:28:37Z

services/spam-ban/spam-banning.service.js

+      let reply;
+
+      if (!message.member) {
+        message.react("❌");


I'm assuming we're reacting to the banned message? So this reaction will be done on a message in a public channel? Not sure we'd want that, but do confirm with others though.

The button will be mainly used on automod messages that are blocked and logged, Which only staff can see. We wont be using this for messages that automod fails to block or doesnt delete. We will use manual modding to make sure that any left over spam msgs will be deleted by us.

Okay, so this command is only for the automod messages. Isn't automod a bot though? Won't message.author.bot always return true? How are we able to get the offending user's id from an automod message? I'm drawing blanks on the documentation, so some links could be helpful 😅

I definitely should set up automod in a dummy server to test this myself instead of bombarding this PR lol

Those are valid questions which I myself had, and made up an environment to explore. To my surprise however is that the Autobot logs actually act as if those message were posted by the user. message.author is actually the user who's message is blocked by Automod. Yeah certainly set up an environment and test things out

services/spam-ban/spam-banning.service.js

01zulfi · 2024-07-02T06:31:38Z

services/spam-ban/spam-banning.service.test.js

++ for these tests

services/spam-ban/spam-banning.service.js

Asartea · 2024-07-02T10:54:50Z

config.js

@@ -13,6 +13,7 @@ const config = {
    gettingHiredChannelId: process.env.DISCORD_GETTING_HIRED_CHANNEL_ID,
    botSpamPlaygroundChannelId: '513125912070455296',
    FAQChannelId: '823266307293839401',
+    moderationLog: '922520585018433536'


Presuming (based on context), that this is an channel ID, shouldn't this be moderationLogChannelId to preserve consistency in how we name them

Thats right, this should be a channel ID. ++

services/spam-ban/spam-banning.service.js

Asartea · 2024-07-02T10:59:29Z

services/spam-ban/spam-banning.service.js

+    const embedMessage = new EmbedBuilder()
+      .setTitle("Banned: Compromised account / Spam")
+      .setDescription(
+        `Account is compromised and is used to spam phishing links.


Suggested change

`Account is compromised and is used to spam phishing links.

`Your account has been banned from The Odin Project Discord as it is compromised and is used to spam phishing links.

Asartea · 2024-07-02T11:48:48Z

services/spam-ban/spam-banning.service.js

+        `Account is compromised and is used to spam phishing links.
+
+  If you would still like to continue using our server, make sure to change your password and recover your account.
+  After that send a detailed contact information to appeal the ban on [email protected]`,


Suggested change

After that send a detailed contact information to appeal the ban on theodinprojectcontact@gmail.com`,

After that send a ban appeal containing contact information to theodinprojectcontact@gmail.com`,

Additional: Not a team member, but it might be easier if the instructions also say to add something like [Ban Appeal] to the subject or send it to something like [email protected]

Your input is valueable and always appreciated. We might also add a template for them to fill in the email too

Asartea · 2024-07-02T11:50:50Z

services/spam-ban/spam-banning.service.js

+    channel.send({ embeds: [embed] });
+  }
+
+  static #isAdmin(member) {


Nit: it might be worth (probably in a follow up) to refactor check if a user is admin logic to a separate file; I think this is either the third or fourth occurrence of basically this exact code snippet

This logic is duplicated in may other services. This is what im indicating in my PR message. Many of those including tests should be moved to utils. But not sure if we are doing it in this PR or an upcoming one, wanted to see what maintainers think.

This has now happened in #567

Thanks for letting me know, I will integrate it

Mclilzee · 2024-07-12T20:26:45Z

@TheOdinProject/moderators I would like the mod team to weigh on this. What the message to the user would be like, what kind of template. And perhaps some kind of a form so that they can use for the appeal?

This is the current template of the message

Account is compromised and is used to spam phishing links.

If you would still like to continue using our server, make sure to change your password and recover your account.
After that send a detailed contact information to appeal the ban on [email protected]

I would like to especially hear from @JustWaveThings since this was originally your idea, is this how you imagined it to be, or do you think it needs some improvements?

JustWaveThings · 2024-07-12T20:28:55Z

I'll be happy to put together a message to send on the ban. I will look at the functionality of it tonight. Thank you so much for doing this!

JustWaveThings · 2024-07-13T03:43:03Z

@Mclilzee, Here's my take on the message the bot could send:

This account has been banned from The Odin Project Discord server for sending spam. If this account is compromised, please follow the steps linked in this Discord support article to secure your account.

Once your account is secure, you may appeal your ban by emailing [email protected] with your Discord username and that you are appealing your ban due to a compromised account.

Note: It may take several days for our volunteer staff to take action on your appeal, and unbanning is not guaranteed.

I don't know if we need to get fancy with the message. I'm also fine with just sending what we send now in the ban message.

Mclilzee · 2024-07-13T10:18:27Z

@Mclilzee, Here's my take on the message the bot could send:

This account has been banned from The Odin Project Discord server for sending spam. If this account is compromised, please follow the steps linked in this Discord support article to secure your account.

Once your account is secure, you may appeal your ban by emailing [email protected] with your Discord username and that you are appealing your ban due to a compromised account.

Note: It may take several days for our volunteer staff to take action on your appeal, and unbanning is not guaranteed.

I don't know if we need to get fancy with the message. I'm also fine with just sending what we send now in the ban message.

This looks great! Thank you, Fred. This is much better than whatever I can cook with my broken English.

Asartea · 2024-07-13T16:53:33Z

Very minor nit, but I think that the starting This should also be an Your, otherwise you're switching between modes of address

MaoShizhong

Just a quick few nits on grammar/spelling etc.

services/spam-ban/spam-banning.service.js

services/spam-ban/spam-banning.service.test.js

new-era-commands/context-menu/bann-spammer.js

services/spam-ban/spam-banning.service.js

Asartea

LGTM 🚀

MaoShizhong · 2024-08-11T12:10:48Z

new-era-commands/context-menu/bann-spammer.js

Nit, single n in file name ban-spammer.js.

I probably won't have a great deal of time to do a thorough review of the feature itself, I'm more doing little bits here and there, so I'll be cheeky and leave the rump of the stuff to Xari.

Co-authored-by: MaoShizhong <[email protected]>

Co-authored-by: Asartea <[email protected]>

01zulfi

@Mclilzee great stuff 🔥🔥 🔥

01zulfi · 2024-12-14T14:26:11Z

services/spam-ban/spam-banning.service.js

+  }
+
+  static async #announceBan(interaction, message) {
+    const channelID = config.channels.moderationLogChannelId;


Can we add this channel id in the config file?

01zulfi · 2024-12-14T14:29:30Z

services/spam-ban/spam-banning.service.js

+  static async handleInteraction(interaction) {
+    const message = interaction.options.getMessage('message');


I'm assuming we'll be calling this command only inside the automod channel. We'll add this condition in our discord server's setting. Though a sanity check here won't hurt. Can we add a guard here to check if this command is only called in that channel?

01zulfi · 2024-12-14T14:31:01Z

services/spam-ban/spam-banning.service.test.js

+
+    // The mod who initialized the interaction
+    user: {
+      id: '007',


Mclilzee commented Jun 15, 2024

View reviewed changes

services/spam-ban/__snapshots__/spam-banning.service.test.js.snap Outdated Show resolved Hide resolved

Mclilzee changed the title ~~Automated spam ban context menu button~~ Context menu button, Ban Spammer Jul 1, 2024

01zulfi requested changes Jul 2, 2024

View reviewed changes

Asartea reviewed Jul 2, 2024

View reviewed changes

Mclilzee force-pushed the automated-spam-bann branch from 156ac29 to d3ecdb8 Compare August 8, 2024 06:08

MaoShizhong reviewed Aug 8, 2024

View reviewed changes

Asartea reviewed Aug 8, 2024

View reviewed changes

services/spam-ban/spam-banning.service.js Outdated Show resolved Hide resolved

Mclilzee requested review from 01zulfi, MaoShizhong and Asartea August 10, 2024 19:18

Asartea reviewed Aug 11, 2024

View reviewed changes

MaoShizhong reviewed Aug 11, 2024

View reviewed changes

Mclilzee added 13 commits December 1, 2024 03:38

Create context button

8ec607b

Fix calling wrong service

bc93656

Refactor naming

df980ad

Update logic to spammer-banning service

e8664f0

Reformat message to contain new line

765abce

Fix contact email

3615580

Reverse to send message directly

e693636

Fix message sending issue

9b351cf

Update structure of calls

2928b70

Add announcing user banning and failure

818c395

Refactor

0384dcf

Update sending error to stderr channel

9c9a895

Refactor modules

21dafe4

Mclilzee and others added 27 commits December 1, 2024 03:38

Refactor interaction reply to be emphernal

90c52c8

Fix mock time to not fail tests that require timestamp snapshot

55d3b40

Fix comment typo

11a660b

Update permission to mods with ability to ban only

84e08dd

Fix tests for core members

7b06e7e

Update to use user ID

a783143

Update tests

6b37c9b

Update channel id name

4c3d730

Refactor channel name id in tests

def4298

Update user message

844d413

Update channel id name

7f47a61

Update tests

0621b11

Update date object to work with github cli test tools

47e7f75

Update to use fetch method on getting the channel

d13b274

Update to handle fetch promise

5db3444

Add handling error when channel is not found

dfc53bc

Remove mailto link in contact user message

584817e

Send user message to enable embed links

5549d23

Update message to include new mod email

aaa4316

Update test snippets

38349b1

Run prettier

f12cc80

Use new isAdmin util function

62b5a60

Apply suggestions from code review

bda809c

Co-authored-by: MaoShizhong <[email protected]>

Update ban message with appeal template

df4c760

Refactor sentence structure

2bd8cff

Co-authored-by: Asartea <[email protected]>

Update test snippets to reflect newest changes

c61ac3d

Update filename

c7f63ec

Mclilzee force-pushed the automated-spam-bann branch from f319ac5 to c7f63ec Compare December 1, 2024 02:46

Format for linting

c6e0692

01zulfi requested changes Dec 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Context menu button, Ban Spammer #548

Context menu button, Ban Spammer #548

Mclilzee commented Jun 13, 2024

01zulfi Jul 2, 2024

Mclilzee Jul 2, 2024

01zulfi Jul 4, 2024

Mclilzee Jul 4, 2024

01zulfi Jul 2, 2024

Asartea Jul 2, 2024 •

edited

Loading

Mclilzee Jul 2, 2024

Asartea Jul 2, 2024

Asartea Jul 2, 2024

Mclilzee Jul 2, 2024

Asartea Jul 2, 2024

Mclilzee Jul 2, 2024

Asartea Aug 6, 2024

Mclilzee Aug 8, 2024

Mclilzee commented Jul 12, 2024

JustWaveThings commented Jul 12, 2024

JustWaveThings commented Jul 13, 2024 •

edited

Loading

Mclilzee commented Jul 13, 2024

Asartea commented Jul 13, 2024 •

edited

Loading

MaoShizhong left a comment

Asartea left a comment

MaoShizhong Aug 11, 2024

01zulfi left a comment

01zulfi Dec 14, 2024

01zulfi Dec 14, 2024

01zulfi Dec 14, 2024

	`Account is compromised and is used to spam phishing links.
	`Your account has been banned from The Odin Project Discord as it is compromised and is used to spam phishing links.

	After that send a detailed contact information to appeal the ban on theodinprojectcontact@gmail.com`,
	After that send a ban appeal containing contact information to theodinprojectcontact@gmail.com`,

		static async handleInteraction(interaction) {
		const message = interaction.options.getMessage('message');

Context menu button, Ban Spammer #548

Are you sure you want to change the base?

Context menu button, Ban Spammer #548

Conversation

Mclilzee commented Jun 13, 2024

Because

This PR

Issue

Additional Information

Pull Request Requirements

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

Asartea Jul 2, 2024 • 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

Mclilzee commented Jul 12, 2024

JustWaveThings commented Jul 12, 2024

JustWaveThings commented Jul 13, 2024 • edited Loading

Mclilzee commented Jul 13, 2024

Asartea commented Jul 13, 2024 • edited Loading

MaoShizhong left a comment

Choose a reason for hiding this comment

Asartea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

01zulfi left a 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

Asartea Jul 2, 2024 •

edited

Loading

JustWaveThings commented Jul 13, 2024 •

edited

Loading

Asartea commented Jul 13, 2024 •

edited

Loading