13 starboard

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - `/iscasdown` slash command to check if BYU's CAS is working
+- Starboard, and associated commands
 
 ### Changed
 

README.md

@@ -83,6 +83,10 @@ Retrieves the profile picture of the given user.
 
 Not complete. For now, this command simply auto-completes the tag the user types, but it does not send the tag.
 
+### /setreactboard
+
+Creates a new reactboard or updates an existing one. A reactboard is a channel where the bot will repost messages that recieve a specified number of a specified reaction. The primary use is for a starboard where messages that receive the right number of stars will be added, along with how many stars they received.
+
 ### /stats ( track / update / list / leaderboard / untrack )
 
 Tracks a statistic for the issuer. Use the `track` subcommand to begin tracking, `update` to add or subtract to it, `list` to show all the stats being tracked for the issuer, `leaderboard` to show the users with the highest scores for a stat, and `untrack` to stop tracking a stat for you.
@@ -182,7 +186,7 @@ ADMINISTRATORS=COMMA,SEPARATED,ID,LIST
 
 ### Invite your bot to your server
 
-Go to https://discordapi.com/permissions.html#378091424832 and paste in your bot's client ID to get an invite link.
+Go to https://discordapi.com/permissions.html#379165174848 and paste in your bot's client ID to get an invite link.
 
 ### Setting up Docker
 

package.json

@@ -39,7 +39,7 @@
 		"lint:fix": "npm run lint -- --fix",
 		"release": "./node_modules/.bin/tsx ./scripts/release.ts",
 		"restart": "./node_modules/.bin/pm2 restart cs-bot",
-		"setup": "npm ci && npm run export-version && npm run build --production && npm run commands:deploy",
+		"setup": "npm ci && npm run export-version && npm run db:migrate && npm run build --production && npm run commands:deploy",
 		"start": "./node_modules/.bin/pm2 start ./dist/main.js --name cs-bot",
 		"stop": "./node_modules/.bin/pm2 delete cs-bot",
 		"test": "./node_modules/.bin/vitest",

prisma/migrations/20230411151150_reactboard/migration.sql

@@ -0,0 +1,11 @@
+-- CreateTable
+CREATE TABLE "reactboard" (
+    "id" SERIAL NOT NULL,
+    "guildId" TEXT NOT NULL,
+    "channelId" TEXT NOT NULL,
+    "react" TEXT NOT NULL,
+    "isCustomReact" BOOLEAN NOT NULL,
+    "threshold" INTEGER NOT NULL,
+
+    CONSTRAINT "reactboard_pkey" PRIMARY KEY ("id")
+);

prisma/migrations/20230411152017_reactboard_unique_location/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - A unique constraint covering the columns `[guildId,channelId]` on the table `reactboard` will be added. If there are existing duplicate values, this will fail.
+
+*/
+-- CreateIndex
+CREATE UNIQUE INDEX "reactboard_guildId_channelId_key" ON "reactboard"("guildId", "channelId");

prisma/migrations/20230411182041_reactboard_posts/migration.sql

@@ -0,0 +1,12 @@
+-- CreateTable
+CREATE TABLE "reactboardPost" (
+    "id" SERIAL NOT NULL,
+    "reactboardId" INTEGER NOT NULL,
+    "originalMessageId" TEXT NOT NULL,
+    "reactboardMessageId" TEXT NOT NULL,
+
+    CONSTRAINT "reactboardPost_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "reactboardPost" ADD CONSTRAINT "reactboardPost_reactboardId_fkey" FOREIGN KEY ("reactboardId") REFERENCES "reactboard"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

prisma/migrations/20230419170341_reactboard_upper_camel_case/migration.sql

@@ -0,0 +1,43 @@
+/*
+  Warnings:
+
+  - You are about to drop the `reactboard` table. If the table is not empty, all the data it contains will be lost.
+  - You are about to drop the `reactboardPost` table. If the table is not empty, all the data it contains will be lost.
+
+*/
+-- DropForeignKey
+ALTER TABLE "reactboardPost" DROP CONSTRAINT "reactboardPost_reactboardId_fkey";
+
+-- DropTable
+DROP TABLE "reactboard";
+
+-- DropTable
+DROP TABLE "reactboardPost";
+
+-- CreateTable
+CREATE TABLE "Reactboard" (
+    "id" SERIAL NOT NULL,
+    "guildId" TEXT NOT NULL,
+    "channelId" TEXT NOT NULL,
+    "react" TEXT NOT NULL,
+    "isCustomReact" BOOLEAN NOT NULL,
+    "threshold" INTEGER NOT NULL,
+
+    CONSTRAINT "Reactboard_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateTable
+CREATE TABLE "ReactboardPost" (
+    "id" SERIAL NOT NULL,
+    "reactboardId" INTEGER NOT NULL,
+    "originalMessageId" TEXT NOT NULL,
+    "reactboardMessageId" TEXT NOT NULL,
+
+    CONSTRAINT "ReactboardPost_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Reactboard_guildId_channelId_key" ON "Reactboard"("guildId", "channelId");
+
+-- AddForeignKey
+ALTER TABLE "ReactboardPost" ADD CONSTRAINT "ReactboardPost_reactboardId_fkey" FOREIGN KEY ("reactboardId") REFERENCES "Reactboard"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

prisma/migrations/20230419171816_reactboard_original_channel_id/migration.sql

@@ -0,0 +1,8 @@
+/*
+  Warnings:
+
+  - Added the required column `originalChannelId` to the `ReactboardPost` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- AlterTable
+ALTER TABLE "ReactboardPost" ADD COLUMN     "originalChannelId" TEXT NOT NULL;

prisma/schema.prisma

@@ -10,6 +10,28 @@ datasource db {
   url      = env("DATABASE_URL")
 }
 
+model Reactboard {
+	id Int @id @default(autoincrement())
+	guildId String
+	channelId String
+	react String
+	isCustomReact Boolean
+	threshold Int
+
+	@@unique([guildId, channelId], name: "location")
+
+	reactboardPosts ReactboardPost[]
+}
+
+model ReactboardPost {
+	id Int @id @default(autoincrement())
+	reactboardId Int
+	reactboard Reactboard @relation(fields: [reactboardId], references: [id])
+	originalMessageId String
+	originalChannelId String
+	reactboardMessageId String
+}
+
 model Scoreboard {
 	id Int @id @default(autoincrement())
 	userId String
@@ -18,23 +40,6 @@ model Scoreboard {
 	score Float
 }
 
-// All our Models will be defined here
-// Below is an example of what one would look like in our usecase
-// NOTE NOTHING HERE IS FINAL, THIS IS JUST AN EXAMPLE
-// Idk what I am doing
-
-// model Emoteboard {
-//     id        Int      @id @default(autoincrement())
-//     createdAt DateTime @default(now())
-//     author    String
-//     postId    String   @unique
-//     count     Int
-//     emote     Emote    @default(STAR)
-//     channel   String
-//     guild     String
-//     userId    String
-// }
-
 // model Tag {
 // 	id        Int      @id @default(autoincrement())
 // 	createdAt DateTime @default(now())
@@ -49,16 +54,3 @@ model Scoreboard {
 //  starredCount   Int
 //  leaderboards   Leaderboard[]
 // }
-
-// model Leaderboard {
-// 	id         Int      @id @default(autoincrement())
-// 	createdAt  DateTime @default(now())
-//  name       String
-//  users	   User[]
-//  userCounts Int[]
-// }
-
-// enum Emote {
-//     STAR
-//     BASED
-// }

src/@types/ReactionHandler.d.ts

@@ -0,0 +1,12 @@
+import type { MessageReaction, PartialMessageReaction, PartialUser, User } from 'discord.js';
+
+declare global {
+	interface ReactionHandler {
+		execute: (context: ReactionHandlerContext) => void | Promise<void>;
+	}
+
+	interface ReactionHandlerContext {
+		reaction: MessageReaction | PartialMessageReaction;
+		user: User | PartialUser;
+	}
+}

src/commands/setReactboard.test.ts

@@ -0,0 +1,121 @@
+import { beforeEach, describe, expect, test, vi } from 'vitest';
+import type { DeepMockProxy } from 'vitest-mock-extended';
+import { mockDeep } from 'vitest-mock-extended';
+
+import type { PrismaClient } from '@prisma/client';
+import type { TextChannel } from 'discord.js';
+
+import { setReactboard } from './setReactboard.js';
+import { db } from '../database/index.js';
+import { UserMessageError } from '../helpers/UserMessageError.js';
+
+vi.mock('../database', () => ({
+	db: mockDeep<PrismaClient>(),
+}));
+
+describe('setReactboard', () => {
+	const dbMock = db as unknown as DeepMockProxy<PrismaClient>;
+	// eslint-disable-next-line @typescript-eslint/unbound-method
+	const mockUpsert = dbMock.reactboard.upsert;
+
+	const mockGuildId = 'test-guild-id';
+	const mockChannel = {
+		id: 'test-channel-id',
+	};
+	const mockThreshold = 5;
+	const mockReact = '⭐';
+
+	const mockReplyPrivately = vi.fn();
+	const mockGetString = vi.fn<[name: string], string | null>();
+	const mockGetInteger = vi.fn<[name: string], number>();
+	const mockGetChannel = vi.fn<[name: string], TextChannel | null>();
+	const mockGetEmoji = vi.fn();
+	let context: GuildedCommandContext;
+
+	beforeEach(() => {
+		context = {
+			replyPrivately: mockReplyPrivately,
+			options: {
+				getString: mockGetString,
+				getInteger: mockGetInteger,
+				getChannel: mockGetChannel,
+			},
+			guild: {
+				id: mockGuildId,
+				emojis: {
+					fetch: mockGetEmoji,
+				},
+			},
+		} as unknown as GuildedCommandContext;
+
+		mockGetChannel.mockReturnValue(mockChannel as unknown as TextChannel);
+		mockGetInteger.mockReturnValue(mockThreshold);
+		mockGetString.mockReturnValue(mockReact);
+
+		vi.clearAllMocks();
+	});
+
+	test('upserts a reactboard', async () => {
+		await expect(setReactboard.execute(context)).resolves.toBeUndefined();
+		expect(mockUpsert).toHaveBeenCalledTimes(1);
+		expect(mockUpsert).toHaveBeenCalledWith({
+			where: {
+				location: {
+					channelId: mockChannel.id,
+					guildId: mockGuildId,
+				},
+			},
+			update: {
+				threshold: mockThreshold,
+				react: mockReact,
+				isCustomReact: false,
+			},
+			create: {
+				channelId: mockChannel.id,
+				guildId: mockGuildId,
+				threshold: mockThreshold,
+				react: mockReact,
+				isCustomReact: false,
+			},
+		});
+		expect(mockReplyPrivately).toHaveBeenCalledTimes(1);
+	});
+
+	test('upserts a reactboard with a custom emoji', async () => {
+		const customEmojiId = '1234567890';
+		mockGetString.mockReturnValue(`<:abcdef:${customEmojiId}>`);
+		mockGetEmoji.mockReturnValue({
+			id: customEmojiId,
+		});
+
+		await expect(setReactboard.execute(context)).resolves.toBeUndefined();
+		expect(mockUpsert).toHaveBeenCalledTimes(1);
+		expect(mockUpsert).toHaveBeenCalledWith({
+			where: {
+				location: {
+					channelId: mockChannel.id,
+					guildId: mockGuildId,
+				},
+			},
+			update: {
+				threshold: mockThreshold,
+				react: customEmojiId,
+				isCustomReact: true,
+			},
+			create: {
+				channelId: mockChannel.id,
+				guildId: mockGuildId,
+				threshold: mockThreshold,
+				react: customEmojiId,
+				isCustomReact: true,
+			},
+		});
+		expect(mockReplyPrivately).toHaveBeenCalledTimes(1);
+	});
+
+	test('fails with UserMessageError when threshold is below 1', async () => {
+		mockGetInteger.mockReturnValue(0);
+
+		await expect(setReactboard.execute(context)).rejects.toThrow(UserMessageError);
+	});
+});