chore: attempt has been made

Author: uetchy

Makefile

@@ -0,0 +1,3 @@
+deploy:
+	docker-compose -f docker-compose.production.yml up -d --build
+	

STRATEGY.md

@@ -0,0 +1,26 @@
+# ShipID Verification Strategy
+
+1. Live chat presense
+2. Membership joining message presense (Work in progress)
+3. Milestone message presense (Work in progress)
+4. Comment presense (Work in progress)
+
+We suppose having `LIFETIME` variable with `1 week`.
+If user's last verification date is older than `LIFETIME` or never been verified before, verification process will commence.
+
+## Verification
+
+- Search live chats posted by the user within `LIFETIME` time range
+  - If one of the chats has a valid membership badge, the user will be verified.
+  - Otherwise, go to the next step
+- Search membership joining message or milestone message of the user within `LIFETIME` time range
+  - If one of them exists, the user will be verified
+  - Otherwise, go to the next step
+- Ask the user to provide the permalink of the video comment the user has posted on the video
+  - If the comment has a valid membership badge, the user will be verified
+  - After 24 hours without a response, go to the next step
+- Retry livechat strats once again
+  - If verification is successful, the process is complete
+  - Otherwise, go to the next step
+- Delete members-only role from the user
+

docker-compose.development.yml docker-compose.production.yml

@@ -3,20 +3,22 @@ version: "3.1"
 services:
   mongo:
     image: mongo:4
+    restart: unless-stopped
     volumes:
       - ./data/mongo:/data/db
 
   bot:
     build: .
-    command: yarn dev
-    ports:
-      - "3000:3000"
-    volumes:
-      - ./lib:/app/lib
-      - ./src:/app/src
+    restart: unless-stopped
+    command: node .
     env_file: .env
     environment:
       MONGODB_URL: mongodb://mongo:27017/shipid
-      DEBUG: shipid
-    depends_on:
-      - mongo
+      NODE_ENV: production
+    networks:
+      - default
+      - webproxy
+
+networks:
+  webproxy:
+    external: true

docker-compose.yml

@@ -3,22 +3,20 @@ version: "3.1"
 services:
   mongo:
     image: mongo:4
-    restart: unless-stopped
     volumes:
       - ./data/mongo:/data/db
 
   bot:
     build: .
-    restart: unless-stopped
-    command: node .
+    command: yarn dev
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./lib:/app/lib
+      - ./src:/app/src
     env_file: .env
     environment:
       MONGODB_URL: mongodb://mongo:27017/shipid
-      NODE_ENV: production
-    networks:
-      - default
-      - webproxy
-
-networks:
-  webproxy:
-    external: true
+      DEBUG: shipid
+    depends_on:
+      - mongo

jest.config.js

@@ -2,58 +2,58 @@
   "name": "shipid",
   "description": "Fully-automated YouTube Membership Verification Bot",
   "version": "0.0.0",
-  "author": "Yasuaki Uechi <[email protected]> (https://uechi.io/)",
+  "author": "Yasuaki Uechi <[email protected]> (https://uechi.io)",
   "scripts": {
     "build": "tsc",
-    "clean": "shx rm -rf lib && docker-compose down --rmi local",
-    "deploy-commands": "ts-node src/modules/discord/deploy-commands.ts",
+    "clean": "shx rm -rf lib && docker-compose -f docker-compose.production.yml down --rmi local",
+    "deploy-commands": "ts-node src/discord/deploy-commands.ts",
     "dev": "run-p dev:*",
+    "dev:prisma": "nodemon -w prisma/schema.prisma -x prisma generate",
     "dev:server": "nodemon -w lib .",
     "dev:tsc": "tsc -w",
-    "devcontainer": "docker-compose -f docker-compose.development.yml up | grep -v mongo_1",
+    "devcontainer": "docker-compose up | grep -v mongo_1",
     "predevcontainer": "npm run deploy-commands",
     "prepare": "husky install",
-    "start": "node .",
-    "test": "jest"
+    "start": "node ."
   },
   "main": "./lib/index.js",
   "files": [
     "lib"
   ],
   "dependencies": {
-    "@discordjs/builders": "^0.7.0",
-    "@discordjs/rest": "^0.1.0-canary.0",
-    "@typegoose/typegoose": "^8.2.0",
-    "debug": "^4.3.2",
-    "discord-api-types": "^0.24.0",
-    "discord.js": "^13.2.0",
-    "express": "^4.17.1",
+    "@discordjs/builders": "^0.15.0",
+    "@discordjs/rest": "^0.5.0",
+    "@prisma/client": "^4.0.0",
+    "@typegoose/typegoose": "^9.10.1",
+    "debug": "^4.3.4",
+    "discord-api-types": "^0.36.1",
+    "discord.js": "^13.8.1",
+    "express": "^4.18.1",
     "jsonwebtoken": "^8.5.1",
-    "luxon": "^2.0.2",
-    "mongoose": "~5.13.8",
-    "node-fetch": "2",
-    "node-schedule": "^2.0.0"
+    "luxon": "^3.0.1",
+    "mongoose": "~6.4.4",
+    "node-fetch": "3.2.7",
+    "node-schedule": "^2.1.0",
+    "prisma": "^4.0.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",
     "@types/express": "^4.17.13",
-    "@types/jest": "^27.0.2",
-    "@types/jsonwebtoken": "^8.5.5",
-    "@types/luxon": "^2.0.5",
-    "@types/node": "^16.11.1",
-    "@types/node-fetch": "2",
-    "@types/node-schedule": "^1.3.2",
-    "husky": "^7.0.2",
-    "jest": "^27.3.1",
-    "masterchat": "^0.13.0",
-    "nodemon": "^2.0.14",
+    "@types/jest": "^28.1.4",
+    "@types/jsonwebtoken": "^8.5.8",
+    "@types/luxon": "^2.3.2",
+    "@types/node": "^18.0.3",
+    "@types/node-fetch": "2.6.2",
+    "@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.4.1",
-    "pretty-quick": "^3.1.1",
-    "shx": "^0.3.3",
-    "ts-jest": "^27.0.7",
-    "ts-node": "^10.3.0",
-    "typescript": "^4.4.4"
+    "prettier": "^2.7.1",
+    "pretty-quick": "^3.1.3",
+    "shx": "^0.3.4",
+    "ts-node": "^10.8.2",
+    "typescript": "^4.7.4"
   },
   "homepage": "https://github.com/holodata/shipid",
   "repository": {

package.json

@@ -2,6 +2,11 @@ import assert from "assert";
 
 export const isDev = process.env.NODE_ENV !== "production";
 
+export const LIFETIME = Number(process.env.LIFETIME || 1);
+
+export const JWT_SECRET = process.env.JWT_SECRET!;
+assert(JWT_SECRET);
+
 export const DISCORD_CLIENT_ID = process.env.DISCORD_CLIENT_ID!;
 assert(DISCORD_CLIENT_ID, "DISCORD_TOKEN is missing");
 
@@ -14,9 +19,6 @@ assert(DISCORD_TOKEN, "DISCORD_TOKEN is missing");
 export const MONGODB_URL = process.env.MONGODB_URL!;
 if (!isDev) assert(MONGODB_URL, "MONGODB_URL is missing");
 
-export const JWT_SECRET = process.env.JWT_SECRET!;
-assert(JWT_SECRET);
-
 export const HB_MONGO_URI = process.env.HB_MONGO_URI!;
 if (!isDev) assert(HB_MONGO_URI);
 

src/constants.ts

@@ -1,15 +1,18 @@
-import GuildModel from "./models/guild";
+import PairModel, { Pair } from "./models/pair";
 import UserModel, { User } from "./models/user";
-import VerificationModel, { Status } from "./models/verification";
+import CertificateModel, { Certificate } from "./models/certificate";
 
 export async function getUserByDiscordId(discordId: string) {
   return await UserModel.findOne({ discordId });
 }
 
-export async function createOrUpdateUser(
-  discordId: string,
-  { youtubeChannelId }: { youtubeChannelId: string }
-) {
+export async function createOrUpdateUser({
+  discordId,
+  youtubeChannelId,
+}: {
+  discordId: string;
+  youtubeChannelId: string;
+}) {
   const user = await getUserByDiscordId(discordId);
   if (user) {
     user.youtubeChannelId = youtubeChannelId;
@@ -24,64 +27,60 @@ export async function createOrUpdateUser(
   return newUser;
 }
 
-export async function findOrCreateGuild(guildId: string) {
-  const guild = await GuildModel.findOne({ guildId });
-  if (guild) return guild;
-
-  const newGuild = await GuildModel.create({
-    guildId,
-    roleMaps: [],
-    createdAt: new Date(),
-  });
-
-  return newGuild;
+export async function createPair({
+  guildId,
+  roleId,
+  originChannelId,
+}: {
+  guildId: string;
+  roleId: string;
+  originChannelId: string;
+}): Promise<Pair> {
+  const pair = await PairModel.create({ guildId, roleId, originChannelId });
+  return pair;
 }
 
-export async function getRoleMapsForGuild(guildId: string) {
-  const guild = await GuildModel.findOne({ guildId });
-  if (!guild) return undefined;
-
-  const roleMaps = guild.roleMaps;
-  return roleMaps;
+export async function getPairsForGuild(guildId: string): Promise<Pair[]> {
+  const pairs = await PairModel.find({ guildId });
+  return pairs;
 }
 
-export async function findVerification({
+export async function findCertificate({
   user,
   originChannelId,
 }: {
   user: User;
   originChannelId: string;
-}) {
-  return await VerificationModel.findOne({ user, originChannelId });
+}): Promise<Certificate | null> {
+  return await CertificateModel.findOne({ user, originChannelId });
 }
 
-export interface ModifyVerificationOptions {
+export interface ModifyOptions {
   user: User;
   originChannelId: string;
-  status: Status;
+  valid: boolean;
+  since?: string;
 }
 
-export async function updateVerification({
+export async function createOrUpdateCertificate({
   user,
   originChannelId,
-  status,
-}: ModifyVerificationOptions) {
-  return await VerificationModel.updateOne(
-    { user, originChannelId },
-    {
-      status,
-    }
-  );
-}
+  valid,
+  since,
+}: ModifyOptions): Promise<Certificate> {
+  const cert = await findCertificate({ user, originChannelId });
+  if (cert) {
+    cert.valid = valid;
+    cert.since = since;
+    return await cert.save();
+  }
 
-export async function saveVerification({
-  user,
-  originChannelId,
-  status,
-}: ModifyVerificationOptions) {
-  return await VerificationModel.create({
+  const newCert = await CertificateModel.create({
     user,
     originChannelId,
-    status,
+    valid,
+    since,
   });
+
+  return newCert;
 }