Merge pull request #185 from tjjfvi/logs

Write bot logs to a (mod-only) #log channel

Author: robertt

.env.example

@@ -21,3 +21,5 @@ GENERAL_HELP_CHANNEL=
 TIME_BEFORE_HELPER_PING=
 
 SUGGESTIONS_CHANNEL=
+
+LOG_CHANNEL=

src/env.ts

@@ -34,3 +34,5 @@ export const timeBeforeHelperPing = parseInt(
 );
 
 export const suggestionsChannelId = process.env.SUGGESTIONS_CHANNEL!;
+
+export const logChannelId = process.env.LOG_CHANNEL!;

src/index.ts

@@ -2,6 +2,7 @@ import { token, botAdmins } from './env';
 import CookiecordClient from 'cookiecord';
 import { Intents } from 'discord.js';
 import { getDB } from './db';
+import { hookLog } from './log';
 
 import { AutoroleModule } from './modules/autorole';
 import { EtcModule } from './modules/etc';
@@ -51,7 +52,10 @@ for (const mod of [
 getDB(); // prepare the db for later
 
 client.login(token);
-client.on('ready', () => console.log(`Logged in as ${client.user?.tag}`));
+client.on('ready', () => {
+	console.log(`Logged in as ${client.user?.tag}`);
+	hookLog(client);
+});
 
 process.on('unhandledRejection', e => {
 	console.error('Unhandled rejection', e);

src/log.ts

@@ -0,0 +1,73 @@
+import CookiecordClient from 'cookiecord';
+import { Channel, GuildMember, TextChannel, User } from 'discord.js';
+import { inspect } from 'util';
+import { logChannelId } from './env';
+
+const logDebounceTime = 5000;
+const logMaxLength = 2000;
+
+export async function hookLog(client: CookiecordClient) {
+	const guild = client.guilds.cache.get(
+		(await client.guilds.fetch()).first()!.id,
+	)!;
+	const channel = (await guild.channels.fetch(logChannelId)) as TextChannel;
+	let curLogText = '';
+	let timeout: NodeJS.Timeout | null = null;
+	const origLog = console.log;
+	console.log = (...args) => {
+		origLog(...args);
+		postLog(args);
+	};
+	const origError = console.error;
+	console.error = (...args) => {
+		origError(...args);
+		postLog(['[ERROR]', ...args]);
+	};
+	console.log('Writing logs to', channel);
+	function argToString(arg: unknown) {
+		if (typeof arg === 'string') return arg;
+		return inspect(arg);
+	}
+	function postLog(args: unknown[]) {
+		curLogText += `[${new Date().toISOString()}] ${args
+			.map(argToString)
+			.join(' ')}\n`;
+		if (timeout) clearTimeout(timeout);
+		while (curLogText.length > logMaxLength) {
+			const initial =
+				curLogText.match(/^[^]{0,2000}\n/g)?.[0] ??
+				curLogText.slice(0, 2000);
+			curLogText = curLogText.slice(initial.length);
+			postCodeblock(initial);
+		}
+		if (curLogText.trim().length)
+			timeout = setTimeout(() => {
+				postCodeblock(curLogText);
+				curLogText = '';
+			}, logDebounceTime);
+	}
+	async function postCodeblock(content: string) {
+		channel.send(`\`\`\`ts\n${content}\n\`\`\``);
+	}
+}
+
+function defineCustomUtilInspect<T>(
+	Cls: { new (...args: any): T; prototype: T },
+	cb: (value: T) => string,
+) {
+	// @ts-ignore
+	Cls.prototype[inspect.custom] = function () {
+		return cb(this);
+	};
+}
+
+const inspectUser = (user: User) =>
+	`@${user.username}#${user.discriminator}/${user.id}`;
+defineCustomUtilInspect(User, inspectUser);
+defineCustomUtilInspect(GuildMember, member => inspectUser(member.user));
+
+defineCustomUtilInspect(Channel, channel =>
+	'name' in channel
+		? `#${(channel as any).name}/${(channel as Channel).id}`
+		: `#${channel.id}`,
+);

src/modules/autorole.ts

@@ -24,6 +24,7 @@ export class AutoroleModule extends Module {
 				user,
 			});
 			await member.roles.add(ar.roleID);
+			console.log('Gave role', ar.roleID, 'to', member);
 			if (!reaction.users.cache.has(this.client.user!.id)) {
 				await msg.react(reaction.emoji);
 			}
@@ -47,6 +48,7 @@ export class AutoroleModule extends Module {
 				user,
 			});
 			await member.roles.remove(ar.roleID);
+			console.log('Removed role', ar.roleID, 'from', member);
 		}
 	}
 }

src/modules/etc.ts

@@ -136,8 +136,8 @@ export class EtcModule extends Module {
 			.catch(() => false);
 		await confirmationMessage.delete();
 		if (!proceed) return;
-		await msg.react('☠️'),
-			console.log(`
+		await msg.react('☠️');
+		process.stdout.write(`
                             ,--.
                            {    }
                            K,   }

src/modules/handbook.ts

@@ -37,6 +37,7 @@ export class HandbookModule extends Module {
 			return await sendWithMessageOwnership(msg, {
 				embeds: [this.HANDBOOK_EMBED],
 			});
+		console.log('Searching algolia for', [text]);
 		const data = await algolia.search<AlgoliaResult>([
 			{
 				indexName: ALGOLIA_INDEX_NAME,
@@ -47,6 +48,7 @@ export class HandbookModule extends Module {
 				},
 			},
 		]);
+		console.log('Algolia response:', data);
 		const hit = data.results[0].hits[0];
 		if (!hit)
 			return await sendWithMessageOwnership(

src/modules/helpthread.ts

@@ -90,6 +90,12 @@ export class HelpThreadModule extends Module {
 	async onNewQuestion(msg: Message) {
 		if (!isHelpChannel(msg.channel)) return;
 		if (msg.author.id === this.client.user!.id) return;
+		console.log(
+			'Received new question from',
+			msg.author,
+			'in',
+			msg.channel,
+		);
 		this.updateHelpInfo(msg.channel);
 		let thread = await msg.startThread({
 			name: `[Open] Help ${msg.member?.nickname ?? msg.author.username}`,
@@ -100,6 +106,7 @@ export class HelpThreadModule extends Module {
 			threadId: thread.id,
 			ownerId: msg.author.id,
 		}).save();
+		console.log(`Created a new help thread for`, msg.author);
 	}
 
 	// Used to differentiate automatic archive from bot archive
@@ -113,6 +120,7 @@ export class HelpThreadModule extends Module {
 			this.manuallyArchivedThreads.delete(thread.id)
 		)
 			return;
+		console.log(`Help thread expired:`, thread);
 		await thread.send({ embeds: [threadExpireEmbed] });
 		this.manuallyArchivedThreads.add(thread.id);
 		await thread.setName(`[Closed] ${thread.name.replace(/\[.+?] /, '')}`);
@@ -137,6 +145,7 @@ export class HelpThreadModule extends Module {
 			threadData.ownerId === msg.author.id ||
 			msg.member?.permissions.has('MANAGE_MESSAGES')
 		) {
+			console.log(`Closing help thread:`, thread);
 			await msg.react('✅');
 			this.manuallyArchivedThreads.add(thread.id);
 			await thread.setName(

src/modules/mod.ts

@@ -31,6 +31,7 @@ export class ModModule extends Module {
 		await msg.channel.send(
 			`${msg.author} We don't do job posts here; see <#${rulesChannelId}>`,
 		);
+		console.log('Deleted job post message from', msg.author);
 	}
 
 	@listener({ event: 'messageCreate' })
@@ -53,6 +54,13 @@ export class ModModule extends Module {
 						.then(member => void member.kick('Spam')),
 					...recentMessageInfo.messages.map(msg => void msg.delete()),
 				]);
+				console.log(
+					'Kicked',
+					msg.author,
+					'for spam and deleted',
+					recentMessageInfo.messages.length,
+					'identical messages',
+				);
 			}
 		} else {
 			recentMessages.set(messageIdentifier, {

src/modules/rep.ts

@@ -74,6 +74,8 @@ export class RepModule extends Module {
 				to: targetRU,
 			}).save();
 
+			console.log('Gave one rep from', msg.author, 'to', user);
+
 			currentSent++;
 		}
 
@@ -123,6 +125,7 @@ export class RepModule extends Module {
 				(await senderRU.sent()) + 1
 			}/${this.MAX_REP} sent)`,
 		);
+		console.log('Gave one rep from', msg.author, 'to', targetMember.user);
 	}
 
 	@command({