feat: just a spoonful of state machines

Author: uetchy

CONTRIBUTING.md

@@ -21,6 +21,10 @@ docker compose up --build
 docker compose exec bot yarn prisma db push
 ```
 
+```
+/pair channel:UC5CwaMl1eIgY8h02uZw7u8A role:@☄️Hoshiyomi
+```
+
 ## Deploy Guide (Maintainers only)
 
 ```bash

package.json

@@ -6,10 +6,11 @@
   "scripts": {
     "build": "tsc",
     "clean": "shx rm -rf lib && docker-compose -f docker-compose.production.yml down --rmi local",
+    "db:push": "docker compose exec bot yarn prisma db push",
     "deploy-commands": "ts-node src/discord/deploy-commands.ts",
     "dev": "run-p dev:*",
     "dev:prisma": "prisma generate --watch",
-    "dev:server": "nodemon -w lib .",
+    "dev:server": "nodemon -w lib -d 3 -C .",
     "dev:tsc": "tsc -w --preserveWatchOutput",
     "prepare": "husky install",
     "start": "node ."
@@ -31,6 +32,7 @@
     "express": "^4.18.1",
     "jsonwebtoken": "^8.5.1",
     "luxon": "^3.0.1",
+    "masterchat": "^1.1.0",
     "mongoose": "~6.4.4",
     "node-schedule": "^2.1.0",
     "prisma": "^4.0.0"
@@ -44,7 +46,6 @@
     "@types/node": "^18.0.6",
     "@types/node-schedule": "^2.1.0",
     "husky": "^8.0.1",
-    "masterchat": "^1.1.0",
     "nodemon": "^2.0.19",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.7.1",

prisma/schema.prisma

@@ -24,9 +24,9 @@ model Tie {
 model Attestation {
     id              Int      @id @default(autoincrement())
     attestedAt      DateTime @default(now())
-    valid           Boolean
-    since           String?
     originChannelId String
+    isMember        Boolean
+    since           String?
     user            User     @relation(fields: [userDiscordId], references: [discordId])
     userDiscordId   String
 

src/db.ts

@@ -1,12 +1,19 @@
 import { Attestation, PrismaClient, Tie, User } from "@prisma/client";
 
+export interface AttestationOptions {
+  user: User;
+  originChannelId: string;
+  isMember: boolean;
+  since?: string;
+}
+
 const client = new PrismaClient();
 
 export async function getUserByDiscordId(discordId: string) {
   return await client.user.findFirst({ where: { discordId } });
 }
 
-export async function createOrUpdateUser({
+export async function upsertUser({
   discordId,
   youtubeChannelId,
 }: {
@@ -25,7 +32,7 @@ export async function createOrUpdateUser({
   return newOrUpdatedUser;
 }
 
-export async function createPair({
+export async function createTie({
   guildId,
   roleId,
   originChannelId,
@@ -40,12 +47,12 @@ export async function createPair({
   return pair;
 }
 
-export async function getPairsForGuild(guildId: string): Promise<Tie[]> {
+export async function getTiesForGuild(guildId: string): Promise<Tie[]> {
   const pairs = await client.tie.findMany({ where: { guildId } });
   return pairs;
 }
 
-export async function findCertificate({
+export async function findAttestation({
   user,
   originChannelId,
 }: {
@@ -57,25 +64,18 @@ export async function findCertificate({
   });
 }
 
-export interface ModifyOptions {
-  user: User;
-  originChannelId: string;
-  valid: boolean;
-  since?: string;
-}
-
-export async function createOrUpdateCertificate({
+export async function upsertAttestation({
   user,
   originChannelId,
-  valid,
+  isMember,
   since,
-}: ModifyOptions): Promise<Attestation> {
-  const cert = await findCertificate({ user, originChannelId });
+}: AttestationOptions): Promise<Attestation> {
+  const cert = await findAttestation({ user, originChannelId });
   if (cert) {
     const updated = await client.attestation.update({
       where: { id: cert.id },
       data: {
-        valid,
+        isMember,
         since: since ?? null,
       },
     });
@@ -85,10 +85,10 @@ export async function createOrUpdateCertificate({
   const newCert = await client.attestation.create({
     data: {
       user: {
-        connect: user,
+        connect: { discordId: user.discordId },
       },
       originChannelId,
-      valid,
+      isMember,
       since,
     },
   });

src/discord/bot.ts

@@ -1,6 +1,6 @@
 import { Client, GatewayIntentBits } from "discord.js";
 import { HONEYBEE_URI } from "../constants";
-import { Honeybee } from "../honeybee";
+import { Honeybee } from "../notaries/chat";
 import { debugLog, log } from "../util";
 import { commands } from "./commands";
 import { CommandContext } from "./interfaces";

src/discord/commands/index.ts

@@ -1,5 +1,5 @@
 import { Command } from "../interfaces";
 import pair from "./pair";
-import verify from "./verify";
+import verify from "./reverify";
 
 export const commands: Command[] = [verify, pair];

src/discord/commands/pair.ts

@@ -5,13 +5,13 @@ import {
   CommandInteraction,
   PermissionsBitField,
 } from "discord.js";
-import { createPair } from "../../db";
+import { createTie } from "../../db";
 import { debugLog } from "../../util";
 
 export default {
   data: new SlashCommandBuilder()
     .setName("pair")
-    .setDescription("Pair role with YouTube channel")
+    .setDescription("Pair membership role with YouTube channel")
     .addStringOption((option) =>
       option
         .setName("channel")
@@ -36,13 +36,13 @@ export default {
 
     debugLog("channel:", channel, "roleName:", role);
 
-    const pair = await createPair({
+    const tie = await createTie({
       guildId: guild.id,
       roleId: role.id,
       originChannelId: channel,
     });
 
-    debugLog(pair);
+    debugLog(tie);
 
     await intr.reply({
       content: `Success:

src/discord/commands/reverify.ts

@@ -0,0 +1,67 @@
+import { SlashCommandBuilder } from "@discordjs/builders";
+import { debugLog } from "../../util";
+import { Command, RoleChangeset } from "../interfaces";
+import { applyRoleChangesState } from "../states/applyRoles";
+import { notifyState } from "../states/notify";
+import { onboardState } from "../states/onboard";
+import { verifyWithChatState } from "../states/verifyWithChat";
+import { verifyWithCommentState } from "../states/verifyWithComment";
+
+export enum State {
+  START,
+  END,
+  ERROR,
+  ONBOARD,
+  VERIFY_WITH_CHAT,
+  VERIFY_WITH_COMMENT,
+  REGISTER_COMMENT_ID,
+  APPLY_ROLE_CHANGES,
+  NOTIFY,
+}
+
+export interface StateContext {
+  rolesToChange?: RoleChangeset[];
+  error?: string;
+}
+
+const command: Command = {
+  data: new SlashCommandBuilder()
+    .setName("reverify")
+    .setDescription("Force verify membership status"),
+
+  async execute(intr, { hb }) {
+    debugLog("reverify:", intr.user.username);
+
+    const initialState = State.VERIFY_WITH_CHAT;
+
+    let currentState: State = initialState;
+    let context: StateContext = {};
+
+    while (currentState !== State.END) {
+      let next!: [State, StateContext];
+      switch (currentState) {
+        case State.VERIFY_WITH_CHAT:
+          next = await verifyWithChatState(intr, context);
+          break;
+        case State.VERIFY_WITH_COMMENT:
+          next = await verifyWithCommentState(intr, context);
+          break;
+        case State.ONBOARD:
+          next = await onboardState(intr, context);
+          break;
+        case State.APPLY_ROLE_CHANGES:
+          next = await applyRoleChangesState(intr, context);
+          break;
+        case State.NOTIFY:
+          next = await notifyState(intr, context);
+          break;
+        default:
+          throw new Error(`Unrecognized state: ${currentState}`);
+      }
+      currentState = next[0];
+      context = { ...context, ...next[1] };
+    }
+  },
+};
+
+export default command;

src/discord/commands/verify.ts

@@ -1,6 +1,6 @@
 import { SlashCommandBuilder } from "@discordjs/builders";
 import { ChatInputCommandInteraction } from "discord.js";
-import { Honeybee } from "../honeybee";
+import { Honeybee } from "../notaries/chat";
 
 export interface CommandContext {
   hb: Honeybee;
@@ -18,7 +18,7 @@ export interface Command {
 
 export interface RoleChangeset {
   roleId: string;
-  valid: boolean;
+  isMember: boolean;
   since: string | null;
 }