add some tests !

Author: bristermitten

bun.lock

@@ -34,12 +34,14 @@
         "@eslint/js": "^9.32.0",
         "@microsoft/eslint-formatter-sarif": "3.1.0",
         "@sentry/types": "^8.55.0",
+        "@sinonjs/fake-timers": "^14.0.0",
         "@types/bun": "^1.2.19",
         "@types/node": "^22.17.0",
         "@types/node-schedule": "^2.1.8",
         "@types/opentype.js": "^1.3.8",
         "@types/pg": "^8.15.5",
         "@types/sequelize": "^4.28.20",
+        "@types/sinonjs__fake-timers": "^8.1.5",
         "@types/sqlite3": "^3.1.11",
         "@types/string-similarity": "^4.0.2",
         "@types/validator": "^13.15.2",
@@ -250,6 +252,10 @@
 
     "@sequelize/utils": ["@sequelize/[email protected]", "", { "dependencies": { "@types/lodash": "^4.17.16", "lodash": "^4.17.21" } }, "sha512-YOPCa189WimlT10mokbOObkgSJvv3IgEQG7OhszSkQJWDvVjI6WmBsjD+LB2p5IY2kUWyKaRVmaDxW1u/SSQIg=="],
 
+    "@sinonjs/commons": ["@sinonjs/[email protected]", "", { "dependencies": { "type-detect": "4.0.8" } }, "sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ=="],
+
+    "@sinonjs/fake-timers": ["@sinonjs/[email protected]", "", { "dependencies": { "@sinonjs/commons": "^3.0.1" } }, "sha512-QfoXRaUTjMVVn/ZbnD4LS3TPtqOkOdKIYCKldIVPnuClcwRKat6LI2mRZ2s5qiBfO6Fy03An35dSls/2/FEc0Q=="],
+
     "@tootallnate/once": ["@tootallnate/[email protected]", "", {}, "sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw=="],
 
     "@ts-morph/common": ["@ts-morph/[email protected]", "", { "dependencies": { "fast-glob": "^3.2.7", "minimatch": "^3.0.4", "mkdirp": "^1.0.4", "path-browserify": "^1.0.1" } }, "sha512-4tUmeLyXJnJWvTFOKtcNJ1yh0a3SsTLi2MUoyj8iUNznFRN1ZquaNe7Oukqrnki2FzZkm0J9adCNLDZxUzvj+w=="],
@@ -306,6 +312,8 @@
 
     "@types/shimmer": ["@types/[email protected]", "", {}, "sha512-UE7oxhQLLd9gub6JKIAhDq06T0F6FnztwMNRvYgjeQSBeMc1ZG/tA47EwfduvkuQS8apbkM/lpLpWsaCeYsXVg=="],
 
+    "@types/sinonjs__fake-timers": ["@types/[email protected]", "", {}, "sha512-mQkU2jY8jJEF7YHjHvsQO8+3ughTL1mcnn96igfhONmR+fUPSKIkefQYpSe8bsly2Ep7oQbn/6VG5/9/0qcArQ=="],
+
     "@types/sqlite3": ["@types/[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-KYF+QgxAnnAh7DWPdNDroxkDI3/MspH1NMx6m/N/6fT1G6+jvsw4/ZePt8R8cr7ta58aboeTfYFBDxTJ5yv15w=="],
 
     "@types/string-similarity": ["@types/[email protected]", "", {}, "sha512-LkJQ/jsXtCVMK+sKYAmX/8zEq+/46f1PTQw7YtmQwb74jemS1SlNLmARM2Zml9DgdDTWKAtc5L13WorpHPDjDA=="],
@@ -1254,6 +1262,8 @@
 
     "type-check": ["[email protected]", "", { "dependencies": { "prelude-ls": "^1.2.1" } }, "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew=="],
 
+    "type-detect": ["[email protected]", "", {}, "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g=="],
+
     "type-fest": ["[email protected]", "", {}, "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA=="],
 
     "typed-array-buffer": ["[email protected]", "", { "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", "is-typed-array": "^1.1.14" } }, "sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw=="],

package.json

@@ -62,16 +62,18 @@
   ],
   "repository": "https://github.com/TheDeveloperDen/DevDenBot.git",
   "devDependencies": {
-    "@microsoft/eslint-formatter-sarif": "3.1.0",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.32.0",
+    "@microsoft/eslint-formatter-sarif": "3.1.0",
     "@sentry/types": "^8.55.0",
+    "@sinonjs/fake-timers": "^14.0.0",
     "@types/bun": "^1.2.19",
     "@types/node": "^22.17.0",
     "@types/node-schedule": "^2.1.8",
     "@types/opentype.js": "^1.3.8",
     "@types/pg": "^8.15.5",
     "@types/sequelize": "^4.28.20",
+    "@types/sinonjs__fake-timers": "^8.1.5",
     "@types/sqlite3": "^3.1.11",
     "@types/string-similarity": "^4.0.2",
     "@types/validator": "^13.15.2",

src/modules/xp/dailyReward.reminder.test.ts

@@ -0,0 +1,107 @@
+import { test, expect, mock, jest, afterAll } from "bun:test";
+import { Client, Guild, GuildMember, TextChannel } from "discord.js";
+import { DDUser } from "../../store/models/DDUser.js";
+import {
+  scheduleAllReminders,
+  scheduledReminders,
+} from "./dailyReward.reminder.js";
+import { beforeEach } from "node:test";
+import { install } from "@sinonjs/fake-timers";
+
+mock.module("../../store/models/DDUser.js", () => {
+  return {
+    DDUser: {
+      findAll: async () => {
+        return [
+          { id: 1n, lastDailyTime: new Date() },
+          { id: 2n, lastDailyTime: new Date() },
+        ] as DDUser[];
+      },
+      findOrCreate: async (data: { where: { id: bigint } }) => {
+        return [
+          { id: data.where.id, lastDailyTime: new Date() } as DDUser,
+          true,
+        ];
+      },
+    },
+  };
+});
+
+mock.module("../../util/users.js", () => ({
+  isSpecialUser: () => true,
+  actualMention: (user: GuildMember) => `<@${user.id}>`,
+}));
+
+export function fakeTimers() {
+  const clock = install();
+
+  beforeEach(() => {
+    clock.reset();
+  });
+
+  afterAll(() => {
+    clock.uninstall();
+  });
+
+  return clock;
+}
+const clock = fakeTimers();
+test("scheduleAllReminders", async () => {
+  jest.useFakeTimers();
+  console.log(new Date().toLocaleString());
+  const mockGuildFetch = mock(
+    async () =>
+      ({
+        members: {
+          fetch: mockMembersFetch,
+        },
+      }) as unknown as Guild,
+  );
+  const mockChannelSend = mock(async () => Promise.resolve());
+  const mockChannelFetch = mock(
+    async () =>
+      ({
+        isSendable: () => true,
+        send: mockChannelSend,
+      }) as unknown as TextChannel,
+  );
+  const mockMembersFetch = mock(
+    async (id: string) =>
+      ({
+        id: id,
+        user: { tag: `User#${id}` },
+        lastDailyTime: new Date(),
+      }) as unknown as GuildMember,
+  );
+
+  const mockClient = {
+    guilds: {
+      fetch: mockGuildFetch,
+    },
+    channels: {
+      fetch: mockChannelFetch,
+    },
+    members: {
+      fetch: mockMembersFetch,
+    },
+  } as unknown as Client;
+
+  await scheduleAllReminders(mockClient);
+
+  expect(mockGuildFetch).toHaveBeenCalledTimes(1);
+  expect(mockChannelFetch).toHaveBeenCalledTimes(0); // no immediate reminders
+
+  await clock.tickAsync(1000 * 60 * 60 * 25); // fast forward 24 hours
+
+  expect(scheduledReminders.size).toBe(2); // two users should have reminders scheduled
+
+  expect(mockChannelFetch).toHaveBeenCalledTimes(2); // should have sent reminders for both users
+  expect(scheduledReminders.size).toBe(2);
+  expect(mockChannelSend).toHaveBeenCalledTimes(2);
+  expect(mockChannelSend).toHaveBeenCalledWith({
+    content: expect.stringContaining("<@1>"),
+  });
+  expect(mockChannelSend).toHaveBeenCalledWith({
+    content: expect.stringContaining("<@2>"),
+  });
+});

src/modules/xp/dailyReward.reminder.ts

@@ -8,6 +8,9 @@ import {
   getActualDailyStreak,
   getNextDailyTime,
 } from "./dailyReward.command.js";
+import { Op } from "@sequelize/core";
+
+const FORTY_EIGHT_HOURS_IN_MS = 48 * 60 * 60 * 1000;
 
 const sendReminder = async (client: Client, user: GuildMember) => {
   const botCommands = await client.channels.fetch(config.channels.botCommands);
@@ -23,11 +26,15 @@ const sendReminder = async (client: Client, user: GuildMember) => {
     logger.error("lastClaimTime is null");
     return;
   }
-  if (new Date().getTime() - lastClaimTime.getTime() > 1000 * 60 * 60 * 48) {
+  if (
+    new Date().getTime() - lastClaimTime.getTime() >
+    FORTY_EIGHT_HOURS_IN_MS
+  ) {
     logger.info(
       `User ${user.user.tag} has not claimed their daily in over 48 hours, not reminding them and cancelling future reminders`,
     );
     scheduledReminders.get(ddUser.id)?.cancel();
+    scheduledReminders.delete(ddUser.id);
     return;
   }
   await botCommands.send({
@@ -70,6 +77,8 @@ export const scheduleReminder = async (
     return;
   }
 
+  // This will not be perfectly accurate, and if we ever scale to multiple instances of the bot, we'll need to
+  // use a more robust system to avoid duplicate reminders.
   const job = scheduleJob(
     {
       hour: time.getHours(),
@@ -88,13 +97,23 @@ export const scheduleReminder = async (
 
 export const scheduleAllReminders = async (client: Client) => {
   const guild = await client.guilds.fetch(config.guildId);
-  const list = await guild.members.fetch();
-  logger.debug(`Scheduling reminders for ${list.size} members`);
+  const usersWithDaily = await DDUser.findAll({
+    where: {
+      lastDailyTime: {
+        [Op.ne]: undefined,
+      },
+    },
+  });
+
+  logger.debug(`Scheduling reminders for ${usersWithDaily.length} members`);
 
-  for (const member of Array.from(list.values()).filter(isSpecialUser)) {
-    const ddUser = await getOrCreateUserById(BigInt(member.id));
+  for (const ddUser of usersWithDaily) {
+    const member = await guild.members.fetch(ddUser.id.toString());
+    if (!member || !isSpecialUser(member)) {
+      continue;
+    }
     await scheduleReminder(client, member, ddUser);
   }
 };
 
-const scheduledReminders = new Map<bigint, Job>();
+export const scheduledReminders = new Map<bigint, Job>();

src/store/models/Bump.ts

@@ -76,21 +76,13 @@ export function getStreak(
   let currentStreak = 0;
   let highestStreak = 0;
   for (const streak of bumpStreaks) {
-    console.debug(`Streak for user ${userId}:`, streak);
-
     if (streak[0]!.userId === userId) {
       currentStreak += streak.length;
-      console.debug(`Current streak for user ${userId}:`, currentStreak);
     } else {
       highestStreak = Math.max(highestStreak, currentStreak);
-      console.debug(
-        `Reset current streak for user at ${userId}:`,
-        currentStreak,
-      );
       currentStreak = 0;
     }
     highestStreak = Math.max(highestStreak, currentStreak);
-    console.debug(`Highest streak for user ${userId}:`, highestStreak);
   }
   return {
     current: currentStreak,