Merge pull request #165 from tjjfvi/threads

Use a thread based help system

Author: robertt

.env.example

@@ -11,21 +11,11 @@ DATABASE_URL="localhost:5432/tsc-bot"
 # are not given to all server members.
 TRUSTED_ROLE_ID=
 
-# Channel ID to direct users toward for an explanation of the help system.
-ASK_HELP_CHANNEL=
-
 RULES_CHANNEL=
 
-ASK_CATEGORY=
-ONGOING_CATEGORY=
-DORMANT_CATEGORY=
-
-ASK_COOLDOWN_ROLE=
-
-CHANNEL_NAMES=list,help,channel,names,here,seperated,by,commas
+HELP_CATEGORY=
+HOW_TO_GET_HELP_CHANNEL=
+GENERAL_HELP_CHANNEL=
 
-# Following variables are in milliseconds
-DORMANT_CHANNEL_TIMEOUT=
-DORMANT_CHANNEL_LOOP=
-ONGOING_EMPTY_TIMEOUT=
+# Time in milliseconds before !helper can be run
 TIME_BEFORE_HELPER_PING=

src/db.ts

@@ -2,7 +2,7 @@ import { Connection, createConnection } from 'typeorm';
 import { dbUrl } from './env';
 import { RepUser } from './entities/RepUser';
 import { RepGive } from './entities/RepGive';
-import { HelpUser } from './entities/HelpUser';
+import { HelpThread } from './entities/HelpThread';
 import { Snippet } from './entities/Snippet';
 
 let db: Connection | undefined;
@@ -27,7 +27,7 @@ export async function getDB() {
 		url: dbUrl,
 		synchronize: true,
 		logging: false,
-		entities: [RepUser, RepGive, HelpUser, Snippet],
+		entities: [RepUser, RepGive, HelpThread, Snippet],
 		...extraOpts,
 	});
 	console.log('Connected to DB');

src/entities/HelpThread.ts

@@ -0,0 +1,18 @@
+import { BaseEntity, Column, Entity, PrimaryColumn } from 'typeorm';
+
+@Entity()
+export class HelpThread extends BaseEntity {
+	@PrimaryColumn()
+	threadId!: string;
+
+	@Column()
+	ownerId!: string;
+
+	// When @helper was last pinged
+	@Column({ nullable: true })
+	helperTimestamp?: string;
+
+	// When the title was last set
+	@Column({ nullable: true })
+	titleSetTimestamp?: string;
+}

src/entities/HelpUser.ts

@@ -16,39 +16,19 @@ export const autorole = process.env.AUTOROLE!.split(',').map(x => {
 
 export const dbUrl = process.env.DATABASE_URL!;
 
-export const categories = {
-	ask: process.env.ASK_CATEGORY!,
-	ongoing: process.env.ONGOING_CATEGORY!,
-	dormant: process.env.DORMANT_CATEGORY!,
-};
-
-export const askCooldownRoleId = process.env.ASK_COOLDOWN_ROLE!;
+export const helpCategory = process.env.HELP_CATEGORY!;
+export const howToGetHelpChannel = process.env.HOW_TO_GET_HELP_CHANNEL!;
+export const generalHelpChannel = process.env.GENERAL_HELP_CHANNEL!;
 
 export const trustedRoleId = process.env.TRUSTED_ROLE_ID!;
-export const askHelpChannelId = process.env.ASK_HELP_CHANNEL!;
 
 export const rulesChannelId = process.env.RULES_CHANNEL!;
 
-export const channelNames = process.env.CHANNEL_NAMES!.split(',');
-
-export const dormantChannelTimeout = parseInt(
-	process.env.DORMANT_CHANNEL_TIMEOUT!,
-);
-export const dormantChannelTimeoutHours =
-	dormantChannelTimeout / 60 / 60 / 1000;
-export const dormantChannelLoop = parseInt(process.env.DORMANT_CHANNEL_LOOP!);
-
-export const ongoingEmptyTimeout = parseInt(process.env.ONGOING_EMPTY_TIMEOUT!);
+export const TS_BLUE = '#007ACC';
+export const GREEN = '#3ba55d';
+// Picked from Discord's blockquote line
+export const BLOCKQUOTE_GREY = '#4f545c';
 
 export const timeBeforeHelperPing = parseInt(
 	process.env.TIME_BEFORE_HELPER_PING!,
 );
-
-export const TS_BLUE = '#007ACC';
-export const GREEN = '#77b155';
-// Picked from Discord's "hourglass" emoji (in ⌛ | Occupied Help Channels)
-export const HOURGLASS_ORANGE = '#ffa647';
-// Picked from Discord's :ballot_box_with_check: emoji (☑)
-export const BALLOT_BOX_BLUE = '#066696';
-// Picked from Discord's blockquote line
-export const BLOCKQUOTE_GREY = '#4f545c';

src/env.ts

@@ -5,7 +5,7 @@ import { getDB } from './db';
 
 import { AutoroleModule } from './modules/autorole';
 import { EtcModule } from './modules/etc';
-import { HelpChanModule } from './modules/helpchan';
+import { HelpThreadModule } from './modules/helpthread';
 import { PlaygroundModule } from './modules/playground';
 import { RepModule } from './modules/rep';
 import { TwoslashModule } from './modules/twoslash';
@@ -36,7 +36,7 @@ const client = new CookiecordClient(
 for (const mod of [
 	AutoroleModule,
 	EtcModule,
-	HelpChanModule,
+	HelpThreadModule,
 	PlaygroundModule,
 	RepModule,
 	TwoslashModule,