Adjust jobs moderation bot (#335)

* Git commit double lifespan of forhire posts

* Fix negative values

* Stop deleting edited messages. Too many false positives

* Support optional arg in job board validators

* Add dummy env values for test env

* Revise feedback message

* Require that HIRING posts include a link

Author: vcarl

src/features/jobs-moderation.ts

@@ -176,7 +176,7 @@ const jobModeration = async (bot: Client) => {
     if (errors) {
       if (posts.some((p) => p.tags.includes(PostType.forHire))) {
         reportUser({ reason: ReportReasons.jobCircumvent, message });
-        await newMessage.delete();
+        // await newMessage.delete();
       } else {
         await handleErrors(channel, message, errors);
       }
@@ -276,15 +276,14 @@ ${errors.map((e) => `- ${getValidationMessage(e)}`).join("\n")}`,
     await thread.send({
       content: `Hey <@${
         message.author.id
-      }>, your message does not meet our requirements to be posted to the board. This thread acts as a REPL where you can test out new posts against our validation rules.
+      }>, your message does not meet our requirements to be posted to the board. This thread acts as a REPL where you can test out new posts against our validation rules. It was removed for these reasons:
 
-You can view our guidance for job posts here: <https://www.reactiflux.com/promotion#job-board>. It was removed for these reasons:
+${errors.map((e) => `- ${getValidationMessage(e)}`).join("\n")}
 
-${errors.map((e) => `- ${getValidationMessage(e)}`).join("\n")}`,
+View our [guidance for job posts](<https://www.reactiflux.com/promotion#job-board>).`,
       embeds: [
         {
-          title: "Job Board Rules",
-          description: `Here's an example of a valid post:
+          description: `Here's an example of a good HIRING post:
 \`\`\`
 HIRING | REMOTE | FULL-TIME
 

src/features/jobs-moderation/job-mod-helpers.ts

@@ -30,6 +30,7 @@ import {
   PostFailureWeb3Poster,
   PostFailures,
   PostType,
+  PostFailureLinkRequired,
 } from "../../types/jobs-moderation";
 
 export class RuleViolation extends Error {
@@ -56,6 +57,9 @@ export const failedReplyOrMention = (
   e.type === POST_FAILURE_REASONS.replyOrMention;
 export const failedTooLong = (e: PostFailures): e is PostFailureTooLong =>
   e.type === POST_FAILURE_REASONS.tooLong;
+export const failedLinkRequired = (
+  e: PostFailures,
+): e is PostFailureLinkRequired => e.type === POST_FAILURE_REASONS.linkRequired;
 export const failedTooManyLines = (
   e: PostFailures,
 ): e is PostFailureTooManyLines => e.type === POST_FAILURE_REASONS.tooManyLines;
@@ -139,7 +143,7 @@ export const loadJobs = async (bot: Client, channel: TextChannel) => {
 };
 
 const POST_INTERVAL = 7;
-const FORHIRE_AGE_LIMIT = 1.25 * 24;
+const FORHIRE_AGE_LIMIT = 1.25 * 48;
 
 export const deleteAgedPosts = async () => {
   // Delete all `forhire` messages that are older than the age limit

src/features/jobs-moderation/validate.test.ts

@@ -0,0 +1,71 @@
+import { describe, expect, it } from "vitest";
+import { PostType, POST_FAILURE_REASONS } from "../../types/jobs-moderation";
+import { links } from "./validate";
+
+const makePost = (type: PostType, description: string) => [
+  { tags: [type], description },
+];
+
+describe("links", () => {
+  it("requires links", () => {
+    expect(
+      links(
+        makePost(
+          PostType.hiring,
+          "Hiring for some role and stuff\nDM me to apply",
+        ),
+        undefined,
+      ),
+    ).toContainEqual({ type: POST_FAILURE_REASONS.linkRequired });
+    expect(
+      links(
+        makePost(
+          PostType.hiring,
+          "Hiring for some role and stuff\nDM me to apply\nhttps://example.com",
+        ),
+        undefined,
+      ),
+    ).toHaveLength(0);
+    expect(
+      links(
+        makePost(PostType.forHire, "advertising my own skills for hire"),
+        undefined,
+      ),
+    ).toHaveLength(0);
+  });
+  it("doesn't choke on weird urls", () => {
+    const urls = [
+      "https://www.example.com",
+      "https://subdomain.example.com",
+      "https://www.sub.example.com",
+      "https://www.example.com/path/to/page",
+      "https://www.example.com/?query=param",
+      "https://www.example.com/path/to/page?query=param",
+      "https://www.example.com/#section",
+      "https://www.example.com/path/to/page#section",
+      "https://www.example.com/path/to/page?query=param#section",
+      "https://xn--bcher-kva.example/",
+      "https://192.168.0.1",
+      "https://[2001:db8::ff00:42:8329]",
+      "https://www.example.co.uk",
+      "https://www.example.travel",
+      "https://www.example.com:8080",
+      "https://www.example.com:8443",
+      "https://www.example.com/images/pic.jpg",
+      "https://www.example.com/files/document.pdf",
+      "https://www.example.com/path%20with%20spaces",
+    ];
+    expect.assertions(urls.length);
+    urls.forEach((url) => {
+      expect(
+        links(
+          makePost(
+            PostType.hiring,
+            `Hiring for some role and stuff\nDM me to apply\n${url}`,
+          ),
+          undefined,
+        ),
+      ).toHaveLength(0);
+    });
+  });
+});

src/features/jobs-moderation/validate.ts

@@ -19,6 +19,7 @@ const validate = (posts: ReturnType<typeof parseContent>, message: Message) => {
   errors.push(...participation(posts, message));
   errors.push(...web3(posts, message));
   errors.push(...formatting(posts, message));
+  errors.push(...links(posts, message));
   return errors;
 };
 export default validate;
@@ -63,7 +64,7 @@ export const formatting: JobPostValidator = (posts, message) => {
     if (lineCount > maxLines) {
       errors.push({
         type: POST_FAILURE_REASONS.tooManyLines,
-        overage: maxLines - lineCount,
+        overage: lineCount - maxLines,
       });
     }
     const maxChars = isForHire ? 350 : 1800;
@@ -145,3 +146,19 @@ export const participation: JobPostValidator = (posts, message) => {
   }
   return [];
 };
+
+const urlRegex = /(https):\/\/[^\s/$.?#].[^\s]*/g;
+export const links: JobPostValidator<false> = (posts) => {
+  const errors: PostFailures[] = [];
+  posts.forEach(({ tags, description }) => {
+    if (!tags.includes(PostType.hiring)) {
+      return;
+    }
+    const urls = description.match(urlRegex);
+    if (!urls) {
+      errors.push({ type: POST_FAILURE_REASONS.linkRequired });
+    }
+  });
+
+  return errors;
+};

src/features/jobs-moderation/validation-messages.ts

@@ -16,6 +16,7 @@ import {
   failedInconsistentType,
   failedTooLong,
   failedTooManyGaps,
+  failedLinkRequired,
 } from "./job-mod-helpers";
 
 const ValidationMessages = {
@@ -26,6 +27,7 @@ const ValidationMessages = {
   [POST_FAILURE_REASONS.tooManyEmojis]: "Your post has too many emojis.",
   [POST_FAILURE_REASONS.tooLong]: (e: PostFailureTooLong) =>
     `Your post is too long, please shorten it by ${e.overage} characters.`,
+  [POST_FAILURE_REASONS.linkRequired]: `Hiring posts must include a link, either to the company website or a page to apply for the job. Make sure it includes \`https://\` so Discord makes it clickable.`,
   [POST_FAILURE_REASONS.tooManyLines]: (e: PostFailureTooManyLines) =>
     `Your post has too many lines, please shorten it by ${e.overage} lines.`,
   [POST_FAILURE_REASONS.tooManyGaps]:
@@ -56,6 +58,9 @@ export const getValidationMessage = (reason: PostFailures): string => {
   if (failedTooLong(reason)) {
     return ValidationMessages[reason.type](reason);
   }
+  if (failedLinkRequired(reason)) {
+    return ValidationMessages[reason.type];
+  }
   if (failedTooManyLines(reason)) {
     return ValidationMessages[reason.type](reason);
   }

src/helpers/env.ts

@@ -8,6 +8,9 @@ console.log("Running as", isProd() ? "PRODUCTION" : "TEST", "environment");
 
 let ok = true;
 const getEnv = (key: string, optional = false) => {
+  if (process.env.VITEST) {
+    return "dummystring";
+  }
   const value = process.env[key];
   if (!value && !optional) {
     console.log(`Add a ${key} value to .env`);

src/types/jobs-moderation.ts

@@ -11,16 +11,19 @@ export enum PostType {
   forHire = "forhire",
 }
 
-export type JobPostValidator = (
+export type JobPostValidator<WithMessage = true> = (
   posts: Post[],
-  message: Message<boolean>,
+  message: WithMessage extends true
+    ? Message<boolean>
+    : Message<boolean> | undefined,
 ) => PostFailures[];
 
 export const enum POST_FAILURE_REASONS {
   missingType = "missingType",
   inconsistentType = "inconsistentType",
   tooManyEmojis = "tooManyEmojis",
   tooLong = "tooLong",
+  linkRequired = "linkRequired",
   tooManyLines = "tooManyLines",
   tooManyGaps = "tooManyGaps",
   tooFrequent = "tooFrequent",
@@ -49,6 +52,9 @@ export interface PostFailureTooLong {
   type: POST_FAILURE_REASONS.tooLong;
   overage: number;
 }
+export interface PostFailureLinkRequired {
+  type: POST_FAILURE_REASONS.linkRequired;
+}
 export interface PostFailureTooManyGaps {
   type: POST_FAILURE_REASONS.tooManyGaps;
 }
@@ -76,6 +82,7 @@ export type PostFailures =
   | PostFailureInconsistentType
   | PostFailureTooFrequent
   | PostFailureReplyOrMention
+  | PostFailureLinkRequired
   | PostFailureTooLong
   | PostFailureTooManyLines
   | PostFailureTooManyGaps