Regular Role Logging (#292)

src/config.json

@@ -3,7 +3,9 @@
     "BOT_ID": "545281816026677258",
     "COMMAND_PREFIX": "?",
     "MEMBER_ROLE": "592088198746996768",
+    "REGULAR_ROLE": "700614448846733402",
     "MOD_ROLE": "490594428549857281",
+    "REGULAR_ROLE_CHANGE_CHANNEL": "1241698863664988182",
     "SHOWCASE_CHANNEL_ID": "240892912186032129",
     "AUTHENTICATION_MESSAGE_ID": "592316062796873738",
     "AUTHENTICATION_MESSAGE_CHANNEL": "592087564295471105",

src/event/handlers/RegularMemberChangesHandler.ts

@@ -0,0 +1,45 @@
+import { EmbedBuilder, Events, GuildMember, TextChannel } from "discord.js";
+import EventHandler from "../../abstracts/EventHandler";
+import getConfigValue from "../../utils/getConfigValue";
+
+class RegularMemberChangesHandler extends EventHandler {
+	constructor() {
+		super(Events.GuildMemberUpdate);
+	}
+
+	async handle(oldMember: GuildMember, newMember: GuildMember) {
+		if (oldMember.roles.cache.size === newMember.roles.cache.size) {
+			return;
+		}
+
+		const roleId = getConfigValue<string>("REGULAR_ROLE");
+		const hadRoleBefore = oldMember.roles.cache.has(roleId);
+		const hasRoleNow = newMember.roles.cache.has(roleId);
+
+		if (hadRoleBefore && hasRoleNow || !hadRoleBefore && !hasRoleNow) {
+			return;
+		}
+
+		const channelId = getConfigValue<string>("REGULAR_ROLE_CHANGE_CHANNEL");
+		const logChannel = await newMember.guild.channels.fetch(channelId) as TextChannel;
+
+		const embed = new EmbedBuilder();
+
+		embed.setThumbnail(newMember.user.avatarURL());
+		embed.setDescription(`<@${newMember.user.id}>`);
+
+		if (hadRoleBefore && !hasRoleNow) {
+			embed.setTitle("No Longer Regular");
+			embed.setColor("#F71313");
+		}
+
+		if (!hadRoleBefore && hasRoleNow) {
+			embed.setTitle("New Regular Member");
+			embed.setColor("#6CEF0E");
+		}
+
+		logChannel?.send({ embeds: [embed] });
+	}
+}
+
+export default RegularMemberChangesHandler;

test/event/handlers/RegularMemberChangesHandlerTest.ts

@@ -0,0 +1,137 @@
+import { expect } from "chai";
+import {
+	Collection,
+	Events,
+	GuildMember,
+	Role
+} from "discord.js";
+import { createSandbox, SinonSandbox } from "sinon";
+import { BaseMocks, CustomMocks } from "@lambocreeper/mock-discord.js";
+import RegularMemberChangesHandler from "../../../src/event/handlers/RegularMemberChangesHandler";
+import EventHandler from "../../../src/abstracts/EventHandler";
+
+describe("RegularMemberChangesHandler", () => {
+	describe("constructor()", () => {
+		it("creates a handler for GuildMemberUpdate", () => {
+			const handler = new RegularMemberChangesHandler();
+
+			expect(handler.getEvent()).to.equal(Events.GuildMemberUpdate);
+		});
+	});
+
+	describe("handle()", () => {
+		let sandbox: SinonSandbox;
+		let handler: EventHandler;
+		let oldMember: GuildMember;
+		let newMember: GuildMember;
+
+		beforeEach(() => {
+			sandbox = createSandbox();
+			handler = new RegularMemberChangesHandler();
+			oldMember = BaseMocks.getGuildMember();
+			newMember = CustomMocks.getGuildMember();
+		});
+
+		afterEach(() => sandbox.restore());
+
+		it("does nothing if the user's roles have not changed", async () => {
+			const getChannelSpy = sandbox.spy(newMember.guild.channels, "fetch");
+
+			sandbox.stub(oldMember, "roles").get(() => ({
+				cache: new Collection()
+			}));
+
+			sandbox.stub(newMember, "roles").get(() => ({
+				cache: new Collection()
+			}));
+
+			await handler.handle(oldMember, newMember);
+
+			expect(getChannelSpy.called).to.be.false;
+		});
+
+		it("sends a message saying the user has the role, if they now have it", async () => {
+			const channel = BaseMocks.getTextChannel();
+			const sendMessageSpy = sandbox.stub(channel, "send").resolves();
+
+			// @ts-ignore
+			const getChannelSpy = sandbox.stub(newMember.guild.channels, "fetch").resolves(channel);
+
+			sandbox.stub(oldMember, "roles").get(() => ({
+				cache: new Collection()
+			}));
+
+			sandbox.stub(newMember, "roles").get(() => ({
+				cache: new Collection([
+					[
+						"700614448846733402",
+						Reflect.construct(Role,
+							[
+								BaseMocks.getClient(),
+								{
+									id: "700614448846733402",
+									name: "Regular"
+								},
+								BaseMocks.getGuild()
+							]
+						)
+					]
+				])
+			}));
+
+			await handler.handle(oldMember, newMember);
+
+			expect(getChannelSpy.called).to.be.true;
+			expect(sendMessageSpy.called).to.be.true;
+
+			const embed = sendMessageSpy.getCall(0).firstArg.embeds[0];
+
+			expect(embed.data.title).to.equal("New Regular Member");
+			expect(embed.data.color).to.equal(7139086);
+			expect(embed.data.thumbnail.url).to.equal(newMember.user.avatarURL());
+			expect(embed.data.description).to.equal(`<@${newMember.user.id}>`);
+		});
+
+		it("sends a message saying the user does not have the role, if they no longer have it", async () => {
+			const channel = BaseMocks.getTextChannel();
+			const sendMessageSpy = sandbox.stub(channel, "send").resolves();
+
+			// @ts-ignore
+			const getChannelSpy = sandbox.stub(newMember.guild.channels, "fetch").resolves(channel);
+
+			sandbox.stub(oldMember, "roles").get(() => ({
+				cache: new Collection([
+					[
+						"700614448846733402",
+						Reflect.construct(Role,
+							[
+								BaseMocks.getClient(),
+								{
+									id: "700614448846733402",
+									name: "Regular"
+								},
+								BaseMocks.getGuild()
+							]
+						)
+					]
+				])
+			}));
+
+			sandbox.stub(newMember, "roles").get(() => ({
+				cache: new Collection()
+			}));
+
+			await handler.handle(oldMember, newMember);
+
+			expect(getChannelSpy.called).to.be.true;
+			expect(sendMessageSpy.called).to.be.true;
+
+			const embed = sendMessageSpy.getCall(0).firstArg.embeds[0];
+
+			expect(embed.data.title).to.equal("No Longer Regular");
+			expect(embed.data.color).to.equal(16192275);
+			expect(embed.data.thumbnail.url).to.equal(newMember.user.avatarURL());
+			expect(embed.data.description).to.equal(`<@${newMember.user.id}>`);
+		});
+	});
+});