remove unnecessary maybe type union

intended flow: use id fetch function to get role for current guild, use role id to fetch role from discord role cache,
use role in intended use case
currently the role id is hardcoded, needs to be read from some sort of cache which persists the ids in config file
needs to be differentiated by guild id and role type
could be the target of a user configurable frontend in the future

package-lock.json

@@ -1,12 +1,12 @@
 {
 	"name": "node-jellyfin-discord-bot",
-	"version": "1.1.3",
+	"version": "1.1.4",
 	"lockfileVersion": 2,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "node-jellyfin-discord-bot",
-			"version": "1.1.3",
+			"version": "1.1.4",
 			"license": "MIT",
 			"dependencies": {
 				"@discordjs/rest": "^1.7.0",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "node-jellyfin-discord-bot",
-	"version": "1.1.3",
+	"version": "1.1.4",
 	"description": "A discord bot to sync jellyfin accounts with discord roles",
 	"main": "index.js",
 	"license": "MIT",

server/commands/announce.ts

@@ -82,41 +82,5 @@ Für eine Erklärung wie das alles funktioniert mach einfach /mitgucken für ein
 
 }
 
-export async function manageAnnouncementRoles(guild: Guild, reaction: MessageReaction, requestId: string) {
-	const guildId = guild.id
-	logger.info("Managing roles", { guildId, requestId })
-
-	const announcementRole: Role | undefined = (await guild.roles.fetch()).find(role => role.id === config.bot.announcement_role)
-	if (!announcementRole) {
-		logger.error(`Could not find announcement role! Aborting! Was looking for role with id: ${config.bot.announcement_role}`, { guildId, requestId })
-		return
-	}
-
-	const usersWhoWantRole: User[] = (await reaction.users.fetch()).filter(user => !user.bot).map(user => user)
-
-	const allUsers = (await guild.members.fetch())
-
-	const usersWhoHaveRole: GuildMember[] = allUsers
-		.filter(member => member.roles.cache
-			.find(role => role.id === config.bot.announcement_role) !== undefined)
-		.map(member => member)
-
-	const usersWhoNeedRoleRevoked: GuildMember[] = usersWhoHaveRole
-		.filter(userWhoHas => !usersWhoWantRole.map(wanter => wanter.id).includes(userWhoHas.id))
-
-	const usersWhoDontHaveRole: GuildMember[] = allUsers
-		.filter(member => member.roles.cache
-			.find(role => role.id === config.bot.announcement_role) === undefined)
-		.map(member => member)
-
-	const usersWhoNeedRole: GuildMember[] = usersWhoDontHaveRole
-		.filter(userWhoNeeds => usersWhoWantRole.map(wanter => wanter.id).includes(userWhoNeeds.id))
 
 
-	logger.debug(`Theses users will get the role removed: ${JSON.stringify(usersWhoNeedRoleRevoked)}`, { guildId, requestId })
-	logger.debug(`Theses users will get the role added: ${JSON.stringify(usersWhoNeedRole)}`, { guildId, requestId })
-
-	usersWhoNeedRoleRevoked.forEach(user => user.roles.remove(announcementRole))
-	usersWhoNeedRole.forEach(user => user.roles.add(announcementRole))
-}
-

server/constants.ts

@@ -1,6 +1,7 @@
 
-export enum Emotes { "1️⃣", "2️⃣", "3️⃣", "4️⃣", "5️⃣", "6️⃣", "7️⃣", "8️⃣", "9️⃣", "🔟" }
+export enum ValidVoteEmotes { "1️⃣", "2️⃣", "3️⃣", "4️⃣", "5️⃣", "6️⃣", "7️⃣", "8️⃣", "9️⃣", "🔟" }
 export const NONE_OF_THAT = "❌"
+// WIP
 export const Emoji = {
 	"one": "\u0031\uFE0F\u20E3",
 	"two": "\u0032\uFE0F\u20E3",

server/events/handleMessageReactionAdd.ts

@@ -1,7 +1,7 @@
 
 import { Message, MessageReaction, User } from "discord.js";
 import { logger, newRequestId, noGuildId } from "../logger";
-import { Emoji, Emotes, NONE_OF_THAT } from "../constants";
+import { Emoji, ValidVoteEmotes, NONE_OF_THAT } from "../constants";
 import { client } from "../..";
 import { isInitialAnnouncement, isVoteMessage } from "../helper/messageIdentifiers";
 
@@ -22,11 +22,10 @@ export async function execute(messageReaction: MessageReaction, user: User) {
 	}
 
 	logger.info(`Got reaction on message`, { requestId, guildId })
-	//logger.debug(`reactedUponMessage payload: ${JSON.stringify(reactedUponMessage)}`)
 
 	logger.info(`emoji: ${messageReaction.emoji.toString()}`)
 
-	if (!Object.values(Emotes).includes(messageReaction.emoji.toString()) && messageReaction.emoji.toString() !== NONE_OF_THAT) {
+	if (!Object.values(ValidVoteEmotes).includes(messageReaction.emoji.toString()) && messageReaction.emoji.toString() !== NONE_OF_THAT) {
 		logger.info(`${messageReaction.emoji.toString()} currently not handled`)
 		return
 	}
@@ -36,13 +35,11 @@ export async function execute(messageReaction: MessageReaction, user: User) {
 			logger.info(`Reaction is NONE_OF_THAT on a vote message. Handling`, { requestId, guildId })
 			return client.voteController.handleNoneOfThatVote(messageReaction, reactedUponMessage, requestId, guildId)
 		}
-		if (messageReaction.emoji.toString() === Emoji.one) {
-			// do something
-		}
 	}
 	else if (isInitialAnnouncement(reactedUponMessage)) {
 		if (messageReaction.emoji.toString() === Emoji.ticket) {
-			logger.error(`Got a role emoji. Not implemented yet. ${reactedUponMessage.id}`)
+			logger.error(`Got a role emoji. ${reactedUponMessage.id}`)
+			return client.roleController.addMediaRoleToUser(user, messageReaction.message.guild, requestId)
 		}
 		return
 	}

server/events/handleMessageReactionRemove.ts

@@ -0,0 +1,33 @@
+
+import { Message, MessageReaction, User } from "discord.js";
+import { logger, newRequestId, noGuildId } from "../logger";
+import { Emoji } from "../constants";
+import { client } from "../..";
+import { isInitialAnnouncement } from "../helper/messageIdentifiers";
+
+
+export const name = 'messageReactionRemove'
+
+export async function execute(messageReaction: MessageReaction, user: User) {
+	if (user.id == client.user?.id) {
+		logger.info('Skipping bot reaction')
+		return
+	}
+	const requestId = newRequestId()
+	const guildId = messageReaction.message.inGuild() ? messageReaction.message.guildId : noGuildId
+	const reactedUponMessage: Message = messageReaction.message.partial ? await messageReaction.message.fetch() : messageReaction.message
+	if (!messageReaction.message.guild) {
+		logger.warn(`Received messageReactionRemove on non-guild message.`, { requestId })
+		return
+	}
+
+	logger.info(`Got reaction on message`, { requestId, guildId })
+
+	logger.info(`emoji: ${messageReaction.emoji.toString()}`)
+	if (isInitialAnnouncement(reactedUponMessage)) {
+		if (messageReaction.emoji.toString() === Emoji.ticket) {
+			logger.info(`User: ${user.id}, ${user.username} has removed a ticket reaction. Starting role management`, { requestId, guildId })
+			return client.roleController.removeMediaRoleFromUser(user, messageReaction.message.guild, requestId)
+		}
+	}
+}

server/helper/role.controller.ts

@@ -0,0 +1,83 @@
+import { Guild, MessageReaction, Role, User } from "discord.js";
+import { GuildMember } from "discord.js";
+import { logger } from "../logger";
+import { config } from "../configuration";
+import { Maybe } from "../interfaces";
+
+export default class RoleController {
+
+	constructor() { }
+	private getAnnounceRoleIdForGuild(guildId: string): string {
+		const role = config.bot.announcement_role
+		if (!role) throw new Error(`No announcementRole defined for guild ${guildId}`)
+		return role
+	}
+	public async addRoleToUser(member: GuildMember, role: Role, guildId: string, requestId: string) {
+		logger.info(`Adding Role ${role.id} to user ${member.id}|${member.user.username}`, { requestId, guildId })
+		return await member.roles.add(role)
+	}
+	private async removeRoleFromUser(member: GuildMember, role: Role, guildId: string, requestId: string) {
+		logger.info(`Removing Role ${role.id} from user ${member.id}|${member.user.username}`, { requestId, guildId })
+		return await member.roles.remove(role)
+	}
+
+	public async addMediaRoleToUser(user: User, guild: Guild, requestId: string) {
+		const roleToAdd = await this.getAnnouncementRoleForGuild(guild, requestId)
+		if (!roleToAdd) throw new Error(`No announcementRole found to add to user`)
+		const guildMember = await guild.members.fetch(user)
+		return this.addRoleToUser(guildMember, roleToAdd, guild.id, requestId)
+	}
+	public async removeMediaRoleFromUser(user: User, guild: Guild, requestId: string) {
+		const roleToRemove = await this.getAnnouncementRoleForGuild(guild, requestId)
+		if (!roleToRemove) throw new Error(`No announcementRole found to remove from user`)
+		const guildMember = await guild.members.fetch(user)
+		return this.removeRoleFromUser(guildMember, roleToRemove, guild.id, requestId)
+	}
+
+	public async getAnnouncementRoleForGuild(guild: Guild, requestId: string): Promise<Role> {
+		const mediaRole = this.getAnnounceRoleIdForGuild(guild.id)
+		const announcement_role = await guild.roles.fetch()
+			.then(fetchedRoles => fetchedRoles.find(role => role.id === mediaRole))
+			.catch(error => {
+				logger.error(`Could not find announcement_role with id ${config.bot.announcement_role}. Error: ${error}`, { requestId, guildId: guild.id })
+				throw error
+			})
+		if (!announcement_role) throw new Error(`Could not find announcement_role with id ${config.bot.announcement_role}.`)
+		return announcement_role
+	}
+
+	public async assignAnnouncementRolesFromReaction(guild: Guild, reaction: MessageReaction, requestId: string) {
+		const guildId = guild.id
+		logger.info("Managing roles", { guildId, requestId })
+
+		const announcementRole = await this.getAnnouncementRoleForGuild(guild, requestId)
+
+		const usersWhoWantRole: User[] = (await reaction.users.fetch()).filter(user => !user.bot).map(user => user)
+
+		const allUsers = await guild.members.fetch()
+
+		const usersWhoHaveRole: GuildMember[] = allUsers
+			.filter(member => member.roles.cache
+				.find(role => role.id === announcementRole.id) !== undefined)
+			.map(member => member)
+
+		const usersWhoNeedRoleRevoked: GuildMember[] = usersWhoHaveRole
+			.filter(userWhoHas => !usersWhoWantRole.map(wanter => wanter.id).includes(userWhoHas.id))
+
+		const usersWhoDontHaveRole: GuildMember[] = allUsers
+			.filter(member => member.roles.cache
+				.find(role => role.id === announcementRole.id) === undefined)
+			.map(member => member)
+
+		const usersWhoNeedRole: GuildMember[] = usersWhoDontHaveRole
+			.filter(userWhoNeeds => usersWhoWantRole.map(wanter => wanter.id).includes(userWhoNeeds.id))
+
+
+		logger.debug(`Theses users will get the role removed: ${JSON.stringify(usersWhoNeedRoleRevoked)}`, { guildId, requestId })
+		logger.debug(`Theses users will get the role added: ${JSON.stringify(usersWhoNeedRole)}`, { guildId, requestId })
+
+		usersWhoNeedRoleRevoked.forEach(user => this.removeRoleFromUser(user, announcementRole, guild.id, requestId))
+		usersWhoNeedRole.forEach(user => this.addRoleToUser(user, announcementRole, guild.id, requestId))
+	}
+
+}

server/helper/vote.controller.ts

@@ -1,11 +1,11 @@
 import { Guild, GuildScheduledEvent, GuildScheduledEventEditOptions, GuildScheduledEventSetStatusArg, GuildScheduledEventStatus, Message, MessageCreateOptions, MessageReaction, TextChannel } from "discord.js"
-import { Emotes, NONE_OF_THAT } from "../constants"
+import { ValidVoteEmotes, NONE_OF_THAT } from "../constants"
 import { logger, newRequestId } from "../logger"
 import { getMembersWithRoleFromGuild } from "./roleFilter"
 import { config } from "../configuration"
 import { VoteMessage, isVoteEndedMessage, isVoteMessage } from "./messageIdentifiers"
 import { createDateStringFromEvent } from "./dateHelper"
-import { Maybe, voteMessageInputInformation as prepareVoteMessageInput } from "../interfaces"
+import { Maybe, prepareVoteMessageInput } from "../interfaces"
 import format from "date-fns/format"
 import toDate from "date-fns/toDate"
 import differenceInDays from "date-fns/differenceInDays"
@@ -187,7 +187,7 @@ export default class VoteController {
 		let message = `[Abstimmung] für https://discord.com/events/${guildId}/${event.id} \n<@&${config.bot.announcement_role}> Es gibt eine neue Abstimmung für die nächste Watchparty ${createDateStringFromEvent(event.scheduledStartAt, guildId, requestId)}! Stimme hierunter für den nächsten Film ab!\n`
 
 		for (let i = 0; i < movies.length; i++) {
-			message = message.concat(Emotes[i]).concat(": ").concat(movies[i]).concat("\n")
+			message = message.concat(ValidVoteEmotes[i]).concat(": ").concat(movies[i]).concat("\n")
 		}
 		message = message.concat(NONE_OF_THAT).concat(": Wenn dir nichts davon gefällt.")
 
@@ -205,7 +205,7 @@ export default class VoteController {
 		const sentMessage: Message<true> = await (await announcementChannel.fetch()).send(options)
 
 		for (let i = 0; i < movieCount; i++) {
-			sentMessage.react(Emotes[i])
+			sentMessage.react(ValidVoteEmotes[i])
 		}
 		sentMessage.react(NONE_OF_THAT)
 
@@ -248,7 +248,7 @@ export default class VoteController {
 			logger.info("Deleting vote message")
 			lastMessage.unpin()
 			await lastMessage.delete()
-			const event = await this.getOpenEvent(guild, guild.id, requestId)
+			const event = await this.getOpenPollEvent(guild, guild.id, requestId)
 			if (event && votes?.length > 0) {
 				this.updateOpenPollEventWithVoteResults(event, votes, guild, guildId, requestId)
 				this.sendVoteClosedMessage(event, votes[0].movie, guildId, requestId)
@@ -260,9 +260,9 @@ export default class VoteController {
 	*/
 	public async getVotesByEmote(message: VoteMessage, guildId: string, requestId: string): Promise<Vote[]> {
 		const votes: Vote[] = []
-		logger.debug(`Number of items in emotes: ${Object.values(Emotes).length}`, { guildId, requestId })
-		for (let i = 0; i < Object.keys(Emotes).length / 2; i++) {
-			const emote = Emotes[i]
+		logger.debug(`Number of items in emotes: ${Object.values(ValidVoteEmotes).length}`, { guildId, requestId })
+		for (let i = 0; i < Object.keys(ValidVoteEmotes).length / 2; i++) {
+			const emote = ValidVoteEmotes[i]
 			logger.debug(`Getting reaction for emote ${emote}`, { guildId, requestId })
 			const reaction = message.reactions.resolve(emote)
 			logger.debug(`Reaction for emote ${emote}: ${JSON.stringify(reaction, null, 2)}`, { guildId, requestId })
@@ -273,15 +273,15 @@ export default class VoteController {
 		}
 		return votes
 	}
-	public async getOpenEvent(guild: Guild, guildId: string, requestId: string): Promise<GuildScheduledEvent | null> {
+	public async getOpenPollEvent(guild: Guild, guildId: string, requestId: string): Promise<Maybe<GuildScheduledEvent>> {
 		const voteEvents = (await guild.scheduledEvents.fetch())
 			.map((value) => value)
 			.filter(event => event.name.toLowerCase().includes("voting offen"))
 		logger.debug(`Found events: ${JSON.stringify(voteEvents, null, 2)}`, { guildId, requestId })
 
 		if (!voteEvents || voteEvents.length <= 0) {
-			logger.error("Could not find vote event. Cancelling update!", { guildId, requestId })
-			return null
+			logger.error("Could not find an open vote event.", { guildId, requestId })
+			return
 		}
 		return voteEvents[0]
 	}

server/interfaces.ts

@@ -39,7 +39,7 @@ export interface JellyfinConfig {
 	collectionUser: string
 }
 export type PermissionLevel = "VIEWER" | "ADMIN" | "TEMPORARY"
-export interface voteMessageInputInformation {
+export interface prepareVoteMessageInput {
 	movies: string[],
 	startDate: Date,
 	event: GuildScheduledEvent,

server/structures/client.ts

@@ -2,7 +2,6 @@ import { ApplicationCommandDataResolvable, Client, ClientOptions, Collection, Gu
 import fs from 'fs';
 import { ScheduledTask, schedule } from "node-cron";
 import { v4 as uuid } from 'uuid';
-import { manageAnnouncementRoles } from "../commands/announce";
 import { config } from "../configuration";
 import { Maybe } from "../interfaces";
 import { JellyfinHandler } from "../jellyfin/handler";
@@ -11,6 +10,7 @@ import { CommandType } from "../types/commandTypes";
 import { isInitialAnnouncement } from "../helper/messageIdentifiers";
 import VoteController from "../helper/vote.controller";
 import { yavinJellyfinHandler } from "../..";
+import RoleController from "../helper/role.controller";
 
 
 
@@ -19,6 +19,7 @@ export class ExtendedClient extends Client {
 	private commandFilePath = `${__dirname}/../commands`
 	private jellyfin: JellyfinHandler
 	public voteController: VoteController = new VoteController(this, yavinJellyfinHandler)
+	public roleController: RoleController = new RoleController()
 	public commands: Collection<string, CommandType> = new Collection()
 	private announcementChannels: Collection<string, TextChannel> = new Collection() //guildId to TextChannel
 	private announcementRoleHandlerTask: Collection<string, ScheduledTask> = new Collection() //one task per guild
@@ -172,10 +173,10 @@ export class ExtendedClient extends Client {
 				}
 				//logger.debug(`Message: ${JSON.stringify(message, null, 2)}`, { guildId: guild.id, requestId })
 
-				const reactions = message.reactions.resolve("🎫")
+				const ticketReaction = message.reactions.resolve("🎫")
 				//logger.debug(`reactions: ${JSON.stringify(reactions, null, 2)}`, { guildId: guild.id, requestId })
-				if (reactions) {
-					manageAnnouncementRoles(message.guild, reactions, requestId)
+				if (ticketReaction) {
+					this.roleController.assignAnnouncementRolesFromReaction(message.guild, ticketReaction, requestId)
 				} else {
 					logger.error("Did not get reactions! Aborting!", { guildId: guild.id, requestId })
 				}