Merge pull request #223 from tjjfvi/help-forum-changes

Misc help forum changes

Author: orta

.env.example

@@ -20,6 +20,8 @@ HOW_TO_GIVE_HELP_CHANNEL=
 
 HELP_FORUM_CHANNEL=
 HELP_REQUESTS_CHANNEL=
+HELP_FORUM_OPEN_TAG=Open
+HELP_FORUM_RESOLVED_TAG=Resolved
 
 # Time in milliseconds before !helper can be run
 TIME_BEFORE_HELPER_PING=

src/bot.ts

@@ -74,17 +74,19 @@ export class Bot {
 		return botAdmins.includes(user.id);
 	}
 
-	getTrustedMemberError(msg: Message) {
+	isTrusted(msg: Message) {
 		if (!msg.guild || !msg.member || !msg.channel.isTextBased()) {
-			return ":warning: you can't use that command here.";
+			return false;
 		}
 
 		if (
 			!msg.member.roles.cache.has(trustedRoleId) &&
 			!msg.member.permissions.has('ManageMessages')
 		) {
-			return ":warning: you don't have permission to use that command.";
+			return false;
 		}
+
+		return true;
 	}
 
 	async getTargetUser(msg: Message): Promise<User | undefined> {

src/env.ts

@@ -21,6 +21,9 @@ export const howToGiveHelpChannel = process.env.HOW_TO_GIVE_HELP_CHANNEL!;
 export const helpForumChannel = process.env.HELP_FORUM_CHANNEL!;
 export const helpRequestsChannel = process.env.HELP_REQUESTS_CHANNEL!;
 
+export const helpForumOpenTagName = process.env.HELP_FORUM_OPEN_TAG!;
+export const helpForumResolvedTagName = process.env.HELP_FORUM_RESOLVED_TAG!;
+
 export const trustedRoleId = process.env.TRUSTED_ROLE_ID!;
 
 export const rulesChannelId = process.env.RULES_CHANNEL!;

src/modules/helpForum.ts

@@ -1,8 +1,17 @@
-import { ChannelType, ThreadChannel, TextChannel, Channel } from 'discord.js';
+import {
+	ChannelType,
+	ThreadChannel,
+	TextChannel,
+	Channel,
+	ForumChannel,
+	Message,
+} from 'discord.js';
 import { Bot } from '../bot';
 import { HelpThread } from '../entities/HelpThread';
 import {
 	helpForumChannel,
+	helpForumOpenTagName,
+	helpForumResolvedTagName,
 	helpRequestsChannel,
 	howToGetHelpChannel,
 	howToGiveHelpChannel,
@@ -12,14 +21,20 @@ import {
 } from '../env';
 import { sendWithMessageOwnership } from '../util/send';
 
+const MAX_TAG_COUNT = 5;
+
 // Use a non-breaking space to force Discord to leave empty lines alone
-const postGuidelines = listify(`
-How To Get Help
-- Create a new post here with your question.
+const postGuidelines = (here = true) =>
+	listify(`
+**How To Get Help**
+- Create a new post ${
+		here ? 'here' : `in <#${helpForumChannel}>`
+	} with your question.
 - It's always ok to just ask your question; you don't need permission.
 - Someone will (hopefully!) come along and help you.
+- When your question is resolved, type \`!resolved\`.
 \u200b
-How To Get Better Help
+**How To Get Better Help**
 - Explain what you want to happen and why…
 	- …and what actually happens, and your best guess at why.
 	- Include a short code sample and any error messages you got.
@@ -28,24 +43,36 @@ How To Get Better Help
 	- Send the full link in its own message; do not use a link shortener.
 - For more tips, check out StackOverflow's guide on asking good questions: <https://stackoverflow.com/help/how-to-ask>
 \u200b
-If You Haven't Gotten Help
+**If You Haven't Gotten Help**
 Usually someone will try to answer and help solve the issue within a few hours. If not, and if you have followed the bullets above, you can ping helpers by running !helper.
 `);
 
 const howToGiveHelp = listify(`
-How To Give Help
-- The channel sidebar on the left will list threads you have joined.
+**How To Give Help**
+- The channel sidebar on the left will list posts you have joined.
 - You can scroll through the channel to see all recent questions.
 
-How To Give *Better* Help
+**How To Give *Better* Help**
 - Get yourself the <@&${trustedRoleId}> role at <#${rolesChannelId}>
 	- (If you don't like the pings, you can disable role mentions for the server.)
+- As a <@&${trustedRoleId}>, you can:
+	- React to a help post to add tags.
+	- If a post appears to be resolved, run \`!resolved\` to mark it as such.
+		- *Only do this if the asker has indicated that their question has been resolved.*
+	- Conversely, you can run \`!reopen\` if the asker has follow-up questions.
 
-Useful Snippets
+**Useful Snippets**
 - \`!screenshot\` — for if an asker posts a screenshot of code
 - \`!ask\` — for if an asker only posts "can I get help?"
 `);
 
+const helperResolve = (owner: string, helper: string) => `
+<@${owner}>
+Because your issue seemed to be resolved, this post was marked as resolved by <@${helper}>.
+If your issue is not resolved, **you can reopen this post by running \`!reopen\`**.
+*If you have a different question, make a new post in <#${helpForumChannel}>.*
+`;
+
 export async function helpForumModule(bot: Bot) {
 	const channel = await bot.client.guilds.cache
 		.first()
@@ -55,6 +82,8 @@ export async function helpForumModule(bot: Bot) {
 		return;
 	}
 	const forumChannel = channel;
+	const openTag = getTag(forumChannel, helpForumOpenTagName);
+	const resolvedTag = getTag(forumChannel, helpForumResolvedTagName);
 
 	const helpRequestChannel = await bot.client.guilds.cache
 		.first()
@@ -64,7 +93,7 @@ export async function helpForumModule(bot: Bot) {
 		return;
 	}
 
-	await forumChannel.setTopic(postGuidelines);
+	await forumChannel.setTopic(postGuidelines());
 
 	bot.client.on('threadCreate', async thread => {
 		const owner = await thread.fetchOwner();
@@ -80,6 +109,8 @@ export async function helpForumModule(bot: Bot) {
 			threadId: thread.id,
 			ownerId: owner.user.id,
 		}).save();
+
+		await setStatus(thread, openTag);
 	});
 
 	bot.client.on('threadDelete', async thread => {
@@ -91,12 +122,12 @@ export async function helpForumModule(bot: Bot) {
 
 	bot.registerCommand({
 		aliases: ['helper', 'helpers'],
-		description: 'Help System: Ping the @Helper role from a help thread',
+		description: 'Help System: Ping the @Helper role from a help post',
 		async listener(msg, comment) {
 			if (!isHelpThread(msg.channel)) {
 				return sendWithMessageOwnership(
 					msg,
-					':warning: You may only ping helpers from a help thread',
+					':warning: You may only ping helpers from a help post',
 				);
 			}
 
@@ -105,7 +136,7 @@ export async function helpForumModule(bot: Bot) {
 
 			// Ensure the user has permission to ping helpers
 			const isAsker = msg.author.id === threadData.ownerId;
-			const isTrusted = bot.getTrustedMemberError(msg) === undefined; // No error if trusted
+			const isTrusted = bot.isTrusted(msg);
 
 			if (!isAsker && !isTrusted) {
 				return sendWithMessageOwnership(
@@ -157,10 +188,75 @@ export async function helpForumModule(bot: Bot) {
 		},
 	});
 
+	bot.registerCommand({
+		aliases: ['resolved', 'resolve', 'close', 'closed', 'done'],
+		description: 'Help System: Mark a post as resolved',
+		async listener(msg) {
+			changeStatus(msg, true);
+		},
+	});
+
+	bot.registerCommand({
+		aliases: ['reopen', 'open', 'unresolved', 'unresolve'],
+		description: 'Help System: Reopen a resolved post',
+		async listener(msg) {
+			changeStatus(msg, false);
+		},
+	});
+
+	bot.client.on('messageReactionAdd', async reaction => {
+		const message = reaction.message;
+		const thread = await message.channel.fetch();
+		if (!isHelpThread(thread)) {
+			return;
+		}
+		const initial = await thread.fetchStarterMessage();
+		if (initial?.id !== message.id) return;
+		const tag = forumChannel.availableTags.find(
+			t =>
+				t.emoji &&
+				!t.moderated &&
+				t.emoji.id === reaction.emoji.id &&
+				t.emoji.name === reaction.emoji.name,
+		);
+		if (!tag) return;
+		if (thread.appliedTags.length < MAX_TAG_COUNT) {
+			await thread.setAppliedTags([...thread.appliedTags, tag.id]);
+		}
+		await reaction.remove();
+	});
+
+	async function changeStatus(msg: Message, resolved: boolean) {
+		const thread = msg.channel;
+		if (!isHelpThread(thread)) {
+			return sendWithMessageOwnership(
+				msg,
+				':warning: Can only be run in a help post',
+			);
+		}
+
+		const threadData = await getHelpThread(thread.id);
+		const isAsker = msg.author.id === threadData.ownerId;
+		const isTrusted = bot.isTrusted(msg);
+
+		if (!isAsker && !isTrusted) {
+			return sendWithMessageOwnership(
+				msg,
+				':warning: Only the asker can change the status of a help post',
+			);
+		}
+
+		await setStatus(thread, resolved ? resolvedTag : openTag);
+		await msg.react('✅');
+
+		if (resolved && !isAsker) {
+			await thread.send(helperResolve(thread.ownerId!, msg.author.id));
+		}
+	}
+
 	bot.registerAdminCommand({
 		aliases: ['htgh'],
 		async listener(msg) {
-			if (!bot.isMod(msg.member)) return;
 			if (
 				msg.channel.id !== howToGetHelpChannel &&
 				msg.channel.id !== howToGiveHelpChannel
@@ -170,9 +266,10 @@ export async function helpForumModule(bot: Bot) {
 			(await msg.channel.messages.fetch()).forEach(x => x.delete());
 			const message =
 				msg.channel.id === howToGetHelpChannel
-					? postGuidelines
+					? postGuidelines(false)
 					: howToGiveHelp;
-			msg.channel.send(message);
+			// Force a blank line at the beginning of the message for compact-mode users
+			msg.channel.send(`** **\n` + message.trim());
 		},
 	});
 
@@ -202,6 +299,22 @@ export async function helpForumModule(bot: Bot) {
 			channel.parent?.id === forumChannel.id
 		);
 	}
+
+	function getTag(channel: ForumChannel, name: string) {
+		const tag = channel.availableTags.find(x => x.name === name);
+		if (!tag) throw new Error(`Could not find tag ${name}`);
+		return tag.id;
+	}
+
+	async function setStatus(thread: ThreadChannel, tag: string) {
+		let tags = thread.appliedTags.filter(
+			x => x !== openTag && x !== resolvedTag,
+		);
+		if (tags.length === MAX_TAG_COUNT) {
+			tags = tags.slice(0, -1);
+		}
+		await thread.setAppliedTags([tag, ...tags]);
+	}
 }
 
 function listify(text: string) {