Thread enforcer module (#84)

* Improve module typing

* Upgrade to node 16

* Adds thread enforcer module

* Bumps chart version

Author: maxine4j

Dockerfile

@@ -1,12 +1,12 @@
-FROM node:14-alpine as base
+FROM node:16-alpine as base
 WORKDIR /app
 COPY package.json yarn.lock ./
 RUN yarn install --frozen-lockfile --network-timeout 600000
 COPY tsconfig.json /app
 COPY src/ /app/src/
 RUN yarn build
 
-FROM node:14-alpine
+FROM node:16-alpine
 WORKDIR /app
 COPY package.json yarn.lock ./
 RUN yarn install --frozen-lockfile --network-timeout 600000 --prod

helm/citsbot/Chart.yaml

@@ -1,4 +1,4 @@
 apiVersion: v2
 description: UWA CSDS Discord Bot
 name: citsbot
-version: 1.16.4
+version: 1.17.0

helm/citsbot/values.local.yaml

@@ -67,3 +67,21 @@ instances:
           - anime
           - manga
           keywordCountThreshold: 5
+        threadEnforcer:
+          channels:
+            - channelId: '957264516327018516'
+              channelName: '#project-showcase'
+              topicSingular: 'project'
+              topicPlural: 'projects'
+            - channelId: '957223775269703701'
+              channelName: '#job-opportunities'
+              topicSingular: 'job opportunity'
+              topicPlural: 'job opportunities'
+          ruleBreakDm: |-
+            Hey {username} 👋, I deleted your message in {channelName} because all discussions about individual {topicPlural} should take place in threads 🧵.
+
+            ℹ️ Enforcing the use of threads ensures that the {topicPlural} you and everyone else share stay as visible as possible for as long as possible. You can create a new thread by right clicking or long pressing on a message and selecting "Create Thread". Please see this article for more about Discord's threads feature: https://support.discord.com/hc/en-us/articles/4403205878423.
+
+            💡 If you are trying to share a new {topicSingular}, please ensure you include a link to it in your message.
+
+            🚩 If you believe this action was taken in error, please reach out to one of the server moderators.

helm/citsbot/values.prod.yaml

@@ -412,3 +412,21 @@ instances:
           - anime
           - manga
           keywordCountThreshold: 5
+        threadEnforcer:
+          channels:
+            - channelId: '862342865270472704'
+              channelName: '#project-showcase'
+              topicSingular: 'project'
+              topicPlural: 'projects'
+            - channelId: '910432145217028136'
+              channelName: '#job-opportunities'
+              topicSingular: 'job opportunity'
+              topicPlural: 'job opportunities'
+          ruleBreakDm: |-
+            Hey {username} 👋, I deleted your message in {channelName} because all discussions about individual {topicPlural} should take place in threads 🧵.
+
+            ℹ️ Enforcing the use of threads ensures that the {topicPlural} you and everyone else share stay as visible as possible for as long as possible. You can create a new thread by right clicking or long pressing on a message and selecting "Create Thread". Please see this article for more about Discord's threads feature: https://support.discord.com/hc/en-us/articles/4403205878423.
+
+            💡 If you are trying to share a new {topicSingular}, please ensure you include a link to it in your message.
+
+            🚩 If you believe this action was taken in error, please reach out to one of the server moderators.

package.json

@@ -13,34 +13,34 @@
     "lint": "eslint \"src/**/*.ts\" --fix"
   },
   "dependencies": {
-    "cheerio": "1.0.0-rc.3",
-    "discord.js": "12.3.1",
-    "node-fetch": "2.6.1",
-    "node-schedule": "1.3.2",
-    "prom-client": "12.0.0",
-    "winston": "3.3.3",
-    "winston-transport": "4.4.0"
+    "cheerio": "1.0.0-rc.10",
+    "discord.js": "12.5.3",
+    "node-fetch": "2.6.7",
+    "node-schedule": "2.1.0",
+    "prom-client": "14.0.1",
+    "winston": "3.6.0",
+    "winston-transport": "4.5.0"
   },
   "devDependencies": {
-    "@tsconfig/node14": "1.0.0",
-    "@types/cheerio": "0.22.22",
-    "@types/jest": "26.0.14",
-    "@types/node": "14.11.2",
-    "@types/node-fetch": "2.5.7",
-    "@types/node-schedule": "1.3.1",
-    "@types/ws": "7.4.0",
-    "@typescript-eslint/eslint-plugin": "4.2.0",
-    "@typescript-eslint/parser": "4.2.0",
-    "eslint": "7.9.0",
-    "eslint-config-prettier": "6.15.0",
-    "eslint-plugin-prettier": "3.1.4",
-    "jest": "26.4.2",
-    "nock": "13.0.5",
-    "prettier-eslint": "11.0.0",
-    "prettier-eslint-cli": "5.0.0",
-    "ts-jest": "26.4.0",
-    "ts-node": "9.0.0",
-    "ts-node-dev": "1.0.0-pre.63",
-    "typescript": "4.0.3"
+    "@tsconfig/node16": "1.0.2",
+    "@types/cheerio": "0.22.31",
+    "@types/jest": "27.4.1",
+    "@types/node": "17.0.23",
+    "@types/node-fetch": "2.6.1",
+    "@types/node-schedule": "1.3.2",
+    "@types/ws": "8.5.3",
+    "@typescript-eslint/eslint-plugin": "5.16.0",
+    "@typescript-eslint/parser": "5.16.0",
+    "eslint": "8.12.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "jest": "27.5.1",
+    "nock": "13.2.4",
+    "prettier-eslint": "13.0.0",
+    "prettier-eslint-cli": "5.0.1",
+    "ts-jest": "27.1.4",
+    "ts-node": "10.7.0",
+    "ts-node-dev": "1.1.8",
+    "typescript": "4.6.3"
   }
 }

src/discord/discord-bot.ts

@@ -7,7 +7,7 @@ import { discordEmitter, DiscordEmitter } from './metrics';
 import { LoggingService } from '../utils/logging';
 import { discordApi } from './discord-api';
 import { DiscordBot, DiscordAPI, DiscordChannel, DiscordEmoji, DiscordMessage, DiscordMessageAttachment, DiscordReaction, DiscordUser } from './types';
-import { BotModule } from '../domain/module-types';
+import { BotModule } from '../domain/types';
 
 const parseUser = (user: User | PartialUser): DiscordUser => ({
   id: user.id,

src/domain/anime-detector/module.ts

@@ -1,11 +1,15 @@
 import { DiscordMessage, DiscordMessageAttachment } from '../../discord/types';
 import { LoggingService } from '../../utils/logging';
 import { BotAction, BotActionType } from '../action-types';
-import { AnimeDetectorModule, ModuleType } from '../module-types';
+import { BotModule } from '../types';
 import { AnimeDetectorEmitter } from './metrics';
 import { AnimeDetectorService } from './detector-service';
 import { ImageUploaderService } from './upload-image-service';
 
+export interface AnimeDetectorModule extends BotModule {
+  onMessage: (message: DiscordMessage) => Promise<BotAction[]>;
+}
+
 export const animeDetectorModule = (
   { log }: LoggingService,
   emitter: AnimeDetectorEmitter,
@@ -37,7 +41,7 @@ export const animeDetectorModule = (
     return [];
   };
 
-  return { type: ModuleType.AnimeDetector, onMessage };
+  return { onMessage };
 };
 
 const PATTERN_GENERIC_IMAGE = /\w*?(https?:\/\/[^ ]+?\.(jpg|jpeg|png|tif|bmp|gif|webp))\w*?/gi;

src/domain/anime-detector/upload-image-service.ts

@@ -16,7 +16,8 @@ export const imgurImageUploaderService = (
 
     if (!response.ok) throw Error(`Failed to upload image to imgur. Got non-200 response code: ${response.status}, ${await response.text()}`);
 
-    const data = await response.json();
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const data: any = await response.json();
     const imgurLink = data?.data?.link;
     if (typeof imgurLink !== `string`) throw Error(`Failed to upload image to imgur. Link not present in response body: ${JSON.stringify(data)}`);
 

src/domain/config.ts

@@ -11,6 +11,7 @@ export type BotConfig = {
     announcer?: Record<string, unknown>;
     reactRoles?: Record<string, unknown>;
     animeDetector?: Record<string, unknown>;
+    threadEnforcer?: Record<string, unknown>;
   };
 }
 

src/domain/cowsay/formatter.ts

@@ -8,7 +8,7 @@ export const cowsayFormatter = (
   config: CowsayConfig
 ): CowsayFormatter =>
   message => {
-    const sanitizedMessage = message.replace(/`/g, `'`);
+    const sanitizedMessage = message.replaceAll(`\``, `'`);
     const lines = wrapText(sanitizedMessage, config.lineMaxLen);
     let maxLineLen = -1;
     lines.forEach(line => {