Clean up starboard: remove unused parameter and extract shared test helpers

Author: Pdzly

src/modules/starboard/starboard.listener.test.ts

@@ -1,30 +1,10 @@
 import { describe, expect, test } from "bun:test";
-import type { Message } from "discord.js";
 import {
 	getReactionCountForEmoji,
 	getThresholdReactionCount,
 	matchesConfiguredEmoji,
 } from "./starboard.reaction-utils.js";
-
-interface ReactionStub {
-	emoji: {
-		name: string | null;
-		id: string | null;
-	};
-	count: number | null;
-}
-
-const createMessageWithReactions = (reactions: ReactionStub[]): Message => {
-	return {
-		reactions: {
-			cache: {
-				find: (
-					predicate: (reaction: ReactionStub) => boolean,
-				): ReactionStub | undefined => reactions.find(predicate),
-			},
-		},
-	} as unknown as Message;
-};
+import { createMessageWithReactions } from "./starboard.test-utils.js";
 
 describe("matchesConfiguredEmoji", () => {
 	test("matches unicode emoji with and without variation selector", () => {

src/modules/starboard/starboard.listener.ts

@@ -305,7 +305,6 @@ export const StarboardListener: EventListener = {
 									message,
 									member,
 									effectiveStarCount,
-									undefined,
 									board.config,
 									contentStarCount,
 								);
@@ -439,7 +438,6 @@ export const StarboardListener: EventListener = {
 					refreshedMessage,
 					member,
 					displayCount,
-					undefined,
 					board.config,
 					contentCount,
 				);
@@ -641,7 +639,6 @@ async function updateBoardMessage(
 			reactionMessage,
 			member,
 			starCount,
-			undefined,
 			board.config,
 			contentStarCount,
 		);

src/modules/starboard/starboard.test-utils.ts

@@ -0,0 +1,35 @@
+import type { Message } from "discord.js";
+
+export interface ReactionStub {
+	emoji: {
+		name: string | null;
+		id: string | null;
+	};
+	count: number | null;
+}
+
+const buildReactionsCache = (reactions: ReactionStub[]) => ({
+	cache: {
+		find: (
+			predicate: (reaction: ReactionStub) => boolean,
+		): ReactionStub | undefined => reactions.find(predicate),
+	},
+});
+
+export const createMessageWithReactions = (
+	reactions: ReactionStub[],
+): Message => {
+	return {
+		reactions: buildReactionsCache(reactions),
+	} as unknown as Message;
+};
+
+export const createMessageWithUrlAndReactions = (
+	url: string,
+	reactions: ReactionStub[],
+): Pick<Message, "url" | "reactions"> => {
+	return {
+		url,
+		reactions: buildReactionsCache(reactions),
+	} as Pick<Message, "url" | "reactions">;
+};

src/modules/starboard/starboard.test.ts

@@ -1,34 +1,10 @@
 import { describe, expect, test } from "bun:test";
-import type { Message } from "discord.js";
 import { config } from "../../Config.js";
 import {
 	buildStarboardMessageContent,
 	type StarboardContentRenderOptions,
 } from "./starboard.content.js";
-
-interface ReactionStub {
-	emoji: {
-		name: string | null;
-		id: string | null;
-	};
-	count: number | null;
-}
-
-const createMessageWithReactions = (
-	url: string,
-	reactions: ReactionStub[],
-): Pick<Message, "url" | "reactions"> => {
-	return {
-		url,
-		reactions: {
-			cache: {
-				find: (
-					predicate: (reaction: ReactionStub) => boolean,
-				): ReactionStub | undefined => reactions.find(predicate),
-			},
-		},
-	} as Pick<Message, "url" | "reactions">;
-};
+import { createMessageWithUrlAndReactions } from "./starboard.test-utils.js";
 
 const starboardRenderOptions: StarboardContentRenderOptions = {
 	emojiId: config.starboard.emojiId,
@@ -43,15 +19,18 @@ describe("buildStarboardMessageContent", () => {
 			throw new Error("antiStarboard config is required for this test");
 		}
 
-		const message = createMessageWithReactions("https://discord.test/message", [
-			{
-				emoji: {
-					name: antiStarboard.emojiId,
-					id: null,
+		const message = createMessageWithUrlAndReactions(
+			"https://discord.test/message",
+			[
+				{
+					emoji: {
+						name: antiStarboard.emojiId,
+						id: null,
+					},
+					count: 2,
 				},
-				count: 2,
-			},
-		]);
+			],
+		);
 
 		expect(
 			buildStarboardMessageContent(message, 5, starboardRenderOptions),
@@ -61,7 +40,7 @@ describe("buildStarboardMessageContent", () => {
 	});
 
 	test("omits the anti-star hint when there are no anti-stars", () => {
-		const message = createMessageWithReactions(
+		const message = createMessageWithUrlAndReactions(
 			"https://discord.test/message",
 			[],
 		);
@@ -77,15 +56,18 @@ describe("buildStarboardMessageContent", () => {
 			throw new Error("antiStarboard config is required for this test");
 		}
 
-		const message = createMessageWithReactions("https://discord.test/message", [
-			{
-				emoji: {
-					name: antiStarboard.emojiId,
-					id: null,
+		const message = createMessageWithUrlAndReactions(
+			"https://discord.test/message",
+			[
+				{
+					emoji: {
+						name: antiStarboard.emojiId,
+						id: null,
+					},
+					count: 2,
 				},
-				count: 2,
-			},
-		]);
+			],
+		);
 
 		expect(
 			buildStarboardMessageContent(message, 2, {

src/modules/starboard/starboard.ts

@@ -149,21 +149,13 @@ export const createStarboardMessageFromMessage: (
 	message: Message,
 	member: GuildMember,
 	stars: number,
-	starboardMessage?: Message,
 	renderOptions?: StarboardRenderOptions,
 	contentStars?: number,
 ) => Promise<{
 	embeds: EmbedBuilder[];
 	content: string;
 	files?: AttachmentBuilder[];
-}> = async (
-	message,
-	member,
-	stars,
-	_starboardMessage,
-	renderOptions,
-	contentStars,
-) => {
+}> = async (message, member, stars, renderOptions, contentStars) => {
 	const settings = renderOptions ?? defaultRenderOptions;
 	const embeds: EmbedBuilder[] = [];
 	const files: AttachmentBuilder[] = [];