drew/blitzcrank
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement /unnag

Browse Source
This commit is contained in:
Drew Malzahn
2025-07-05 18:10:24 -04:00
parent 88679d2eda
commit 8c2e889f2a
6 changed files with 505 additions and 472 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
commands/calendar/nag/checkin.ts
View File

@@ -1,19 +1,19 @@
import { import {
type ChatInputCommandInteraction, type ChatInputCommandInteraction,
SlashCommandBuilder, SlashCommandBuilder,
} from "discord.js"; } from 'discord.js';
import type { Settings } from "./service"; import type {Settings} from './service';
import { Nag, CheckIn } from "./service"; import {Nag, CheckIn} from './service';
const data = new SlashCommandBuilder() const data = new SlashCommandBuilder()
.setName("checkin") .setName('checkin')
.setDescription("Check-in for your daily nag") .setDescription('Check-in for your daily nag')
.addStringOption((option) => .addStringOption(option =>
option option
.setName("text") .setName('text')
.setDescription("Optional description of what you have achieved"), .setDescription('Optional description of what you have achieved'),
); );
async function initialize(settings: Settings) {} async function initialize(settings: Settings) {}
@@ -36,13 +36,15 @@ async function execute(interaction: ChatInputCommandInteraction) {
nagId: nag.id, nagId: nag.id,
lastCheckIn: new Date(Date.now()), lastCheckIn: new Date(Date.now()),
}); });
await interaction.reply("Thanks for checking in!"); await interaction.reply('Thanks for checking in!');
break; break;
} }
} }
export default function () { export default function (settings: Settings) {
return { return {
data, data,
initialize: async () => initialize(settings),
execute: execute,
}; };
} }

54
commands/calendar/nag/nag.ts
View File

@@ -1,36 +1,37 @@
import { import {
type ChatInputCommandInteraction, type ChatInputCommandInteraction,
SlashCommandBuilder, SlashCommandBuilder,
} from "discord.js"; } from 'discord.js';
import { Nag, CheckIn, type Settings } from "./service"; import {Nag, CheckIn, type Settings} from './service';
import { Chrono } from "chrono-node"; import {Chrono} from 'chrono-node';
const data = new SlashCommandBuilder() const data = new SlashCommandBuilder()
.setName("nag") .setName('nag')
.setDescription("Let Blitzcrank nag you every day about something") .setDescription('Let Blitzcrank nag you every day about something')
.addStringOption((option) => .addStringOption(option =>
option option
.setRequired(true) .setRequired(true)
.setName("text") .setName('text')
.setDescription("What you have to do every day"), .setDescription('What you have to do every day'),
) )
.addStringOption((option) => .addStringOption(option =>
option option
.setName("failText") .setName('failtext')
.setDescription("Custom message to be broadcast on failure"), .setDescription('Custom message to be broadcast on failure')
.setRequired(false),
) )
.addBooleanOption((option) => .addBooleanOption(option =>
option option
.setName("mentionHere") .setName('mentionhere')
.setDescription("Whether to DM you or @ a channel") .setDescription('Whether to DM you or @ this channel')
.setRequired(false), .setRequired(false),
); );
async function initialize(settings: Settings) {} async function initialize(settings: Settings) {}
async function execute(interaction: ChatInputCommandInteraction) { async function execute(interaction: ChatInputCommandInteraction) {
const text = interaction.options.getString("text"); const text = interaction.options.getString('text');
if (text === null || text === undefined) { if (text === null || text === undefined) {
await interaction.reply("Nag can't have a blank `text`, try again."); await interaction.reply("Nag can't have a blank `text`, try again.");
return; return;
@@ -38,14 +39,17 @@ async function execute(interaction: ChatInputCommandInteraction) {
// Check if we already have an existing nag. In theory, this should be supported entirely, however // Check if we already have an existing nag. In theory, this should be supported entirely, however
// I want to keep things simple for now. // I want to keep things simple for now.
const existingNags = await Nag.findAll({ const existingNags = await Nag.findAll({
where: { userId: interaction.user.id }, where: {
order: [["createdAt", "ASC"]], userId: interaction.user.id,
},
// order: [["createdAt", "ASC"]],
}); });
console.log('Successfully looked for checkIns');
if (existingNags && existingNags.length > 0) { if (existingNags && existingNags.length > 0) {
// TODO: Hmm... For now, I guess we can just update the database. // TODO: Hmm... For now, I guess we can just update the database.
for (const nag of existingNags) { for (const nag of existingNags) {
nag.text = text; nag.text = text;
nag.failText = interaction.options.getString("failText") ?? undefined; nag.failText = interaction.options.getString('failtext') ?? undefined;
await nag.save(); await nag.save();
break; break;
} }
@@ -61,21 +65,23 @@ async function execute(interaction: ChatInputCommandInteraction) {
channelId: interaction.channel?.id, channelId: interaction.channel?.id,
messageId: interaction.id, messageId: interaction.id,
text: text, text: text,
failText: interaction.options.getString("failText"), failText: interaction.options.getString('failtext'),
mentionHere: interaction.options.getBoolean("mentionHere") ?? false, mentionHere: interaction.options.getBoolean('mentionhere') ?? false,
}); });
await nag.save(); await nag.save();
const chrono = new Chrono(); const chrono = new Chrono();
const checkIn = chrono.parseDate("today at 9AM"); const checkIn = chrono.parseDate('today at 9AM');
if (!checkIn) { if (!checkIn) {
await interaction.reply( await interaction.reply(
"Internal error while saving your nag. Tell Drew the bot is broken!!!", 'Internal error while saving your nag. Tell Drew the bot is broken!!!',
); );
return; return;
} }
await CheckIn.create({ await CheckIn.create({
nagId: nag.id, nag: {
checkIn: checkIn, id: nag.id,
},
lastCheckIn: new Date(Date.now()),
}); });
await interaction.reply( await interaction.reply(
`I'll check every day at 9AM if you've completed '${text}'. If not, I'll nag you! Use /checkin to prevent a shameful callout, and /unnag to cancel.`, `I'll check every day at 9AM if you've completed '${text}'. If not, I'll nag you! Use /checkin to prevent a shameful callout, and /unnag to cancel.`,

38
commands/calendar/nag/service.test.ts
View File

@@ -1,4 +1,4 @@
import { expect, test, vi, it, describe, beforeEach, afterEach } from "vitest"; import {expect, test, vi, it, describe, beforeEach, afterEach} from 'vitest';
import { import {
nextCheckInDate, nextCheckInDate,
initAndSyncTables, initAndSyncTables,
@@ -6,17 +6,17 @@ import {
CheckIn, CheckIn,
findGuiltyNags, findGuiltyNags,
getCheckIn, getCheckIn,
} from "./service"; } from './service';
import { Sequelize, literal, Op } from "sequelize"; import {Sequelize, literal, Op} from 'sequelize';
describe("nextCheckInDate", () => { describe('nextCheckInDate', () => {
beforeEach(() => { beforeEach(() => {
vi.useFakeTimers(); // Tell vitest to use fake timers vi.useFakeTimers(); // Tell vitest to use fake timers
}); });
afterEach(() => { afterEach(() => {
vi.useRealTimers(); // Reset date after test runs vi.useRealTimers(); // Reset date after test runs
}); });
it("Returns 9AM if called before 9AM that day", () => { it('Returns 9AM if called before 9AM that day', () => {
const now = new Date(Date.now()); const now = new Date(Date.now());
let at9AM = new Date( let at9AM = new Date(
now.getFullYear(), now.getFullYear(),
@@ -30,7 +30,7 @@ describe("nextCheckInDate", () => {
); );
expect(nextCheckInDate()).toEqual(at9AM); expect(nextCheckInDate()).toEqual(at9AM);
}); });
it("Returns 9AM tomorrow if called after 9AM", () => { it('Returns 9AM tomorrow if called after 9AM', () => {
const dayInMS = 24 * 60 * 60 * 1000; const dayInMS = 24 * 60 * 60 * 1000;
const now = new Date(Date.now()); const now = new Date(Date.now());
const tomorrow = new Date(Date.now() + dayInMS); const tomorrow = new Date(Date.now() + dayInMS);
@@ -48,14 +48,14 @@ describe("nextCheckInDate", () => {
}); });
}); });
describe("Finding nags without check-ins", async () => { describe('Finding nags without check-ins', async () => {
const sequelize = new Sequelize("sqlite://:memory:"); const sequelize = new Sequelize('sqlite://:memory:');
const exampleNag = { const exampleNag = {
userId: "1234", userId: '1234',
guildId: "1234", guildId: '1234',
channelId: "1234", channelId: '1234',
messageId: "1234", messageId: '1234',
text: "Example nag 1", text: 'Example nag 1',
mentionHere: false, mentionHere: false,
}; };
@@ -66,22 +66,22 @@ describe("Finding nags without check-ins", async () => {
}); });
afterEach(async () => { afterEach(async () => {
await Nag.destroy({ where: {} }); await Nag.destroy({where: {}});
await CheckIn.destroy({ where: {} }); await CheckIn.destroy({where: {}});
vi.useRealTimers(); vi.useRealTimers();
}); });
it("Finds nags without any check-ins", async () => { it('Finds nags without any check-ins', async () => {
const now = new Date(); const now = new Date();
vi.setSystemTime( vi.setSystemTime(
new Date(now.getFullYear(), now.getMonth(), now.getDate(), 9), new Date(now.getFullYear(), now.getMonth(), now.getDate(), 9),
); );
await Nag.create(exampleNag); await Nag.create(exampleNag);
const results = await findGuiltyNags(); const results = await findGuiltyNags();
expect(results.map((nag) => nag.userId)).toEqual(["1234"]); expect(results.map(nag => nag.userId)).toEqual(['1234']);
}); });
it("Ignores nags with a recent check-in", async () => { it('Ignores nags with a recent check-in', async () => {
const newNag = await Nag.create(exampleNag); const newNag = await Nag.create(exampleNag);
newNag.save(); newNag.save();
const currentCheckInTime = getCheckIn(9, 0); const currentCheckInTime = getCheckIn(9, 0);
@@ -92,6 +92,6 @@ describe("Finding nags without check-ins", async () => {
}); });
newCheckIn.save(); newCheckIn.save();
const results = await findGuiltyNags(); const results = await findGuiltyNags();
expect(results.map((nag) => nag.userId)).toEqual([]); expect(results.map(nag => nag.userId)).toEqual([]);
}); });
}); });

29
commands/calendar/nag/service.ts
View File

@@ -1,4 +1,4 @@
import { type Client, TextChannel } from "discord.js"; import {type Client, TextChannel} from 'discord.js';
import { import {
type Sequelize, type Sequelize,
Model, Model,
@@ -8,7 +8,7 @@ import {
DATE, DATE,
literal, literal,
Op, Op,
} from "sequelize"; } from 'sequelize';
export interface Settings { export interface Settings {
client: Client; // Main Discord client object client: Client; // Main Discord client object
@@ -36,7 +36,6 @@ export class Nag extends Model {
} }
export class CheckIn extends Model { export class CheckIn extends Model {
declare nagId: string;
// Date of the last time user ran /checkin // Date of the last time user ran /checkin
declare lastCheckIn: Date; declare lastCheckIn: Date;
} }
@@ -64,22 +63,19 @@ export async function initAndSyncTables(sequelize: Sequelize) {
type: BOOLEAN, type: BOOLEAN,
}, },
}, },
{ sequelize }, {sequelize},
); );
CheckIn.init( CheckIn.init(
{ {
nagId: {
type: INTEGER,
allowNull: false,
},
lastCheckIn: { lastCheckIn: {
type: DATE, type: DATE,
allowNull: false, allowNull: false,
}, },
}, },
{ sequelize }, {sequelize},
); );
CheckIn.hasOne(Nag, { foreignKey: "nagId" }); Nag.hasMany(CheckIn);
CheckIn.belongsTo(Nag);
await Nag.sync(); await Nag.sync();
await CheckIn.sync(); await CheckIn.sync();
} }
@@ -103,13 +99,13 @@ export function getCheckIn(hour: number, offset: number = 0) {
} }
export async function findGuiltyNags() { export async function findGuiltyNags() {
const results = await Nag.findAll({ where: {} }); const results = await Nag.findAll();
const guiltyNags: Nag[] = []; const guiltyNags: Nag[] = [];
const prevCheckIn = getCheckIn(9, -1); const prevCheckIn = getCheckIn(9, -1);
const currentCheckIn = getCheckIn(9, 0); const currentCheckIn = getCheckIn(9, 0);
for (const nag of results) { for (const nag of results) {
console.log("Checking nag: ", nag.id); console.log('Checking nag: ', nag.id);
const checkInResults = await CheckIn.findAll({ const checkInResults = await CheckIn.findAll({
where: { where: {
nagId: nag.id, nagId: nag.id,
@@ -144,7 +140,7 @@ function nextCheckInMs() {
const delayMs = nextCheckInDate().getTime() - Date.now(); const delayMs = nextCheckInDate().getTime() - Date.now();
if (delayMs <= 0) { if (delayMs <= 0) {
// The value of nextCheckInDate is guaranteed to be in the future; if not, that's a bug in the program. // The value of nextCheckInDate is guaranteed to be in the future; if not, that's a bug in the program.
throw Error("Invalid value for nextCheckInDate"); throw Error('Invalid value for nextCheckInDate');
} }
return delayMs; return delayMs;
} }
@@ -163,6 +159,7 @@ export class Manager {
constructor(settings: Settings) { constructor(settings: Settings) {
this.settings = settings; this.settings = settings;
initAndSyncTables(this.settings.db);
} }
start() { start() {
@@ -194,11 +191,11 @@ export class Manager {
const failText = const failText =
nag.failText ?? nag.failText ??
`<@${nag.userId}> didn't complete "${nag.text}". Shame shame!`; `<@${nag.userId}> didn't complete "${nag.text}". Shame shame!`;
const mentionHere = nag.mentionHere ? "<@here> " : ""; const mentionHere = nag.mentionHere ? '<@here> ' : '';
const msg = `${mentionHere}${failText}`; const msg = `${mentionHere}${failText}`;
await channel.send(msg); await channel.send(msg);
} catch (error) { } catch (error) {
console.log("Error while creating Nag:", error); // TODO console.log('Error while creating Nag:', error); // TODO
} }
} }
@@ -208,7 +205,7 @@ export class Manager {
// that isn't running anymore. // that isn't running anymore.
this.interval = undefined; this.interval = undefined;
console.debug("nag.js main loop"); console.debug('nag.js main loop');
const guiltyNags = await findGuiltyNags(); const guiltyNags = await findGuiltyNags();
for (const nag of guiltyNags) { for (const nag of guiltyNags) {
await this.triggerNag(nag); await this.triggerNag(nag);

10
commands/calendar/nag/unnag.ts
View File

@@ -1,20 +1,20 @@
import { import {
type ChatInputCommandInteraction, type ChatInputCommandInteraction,
SlashCommandBuilder, SlashCommandBuilder,
} from "discord.js"; } from 'discord.js';
import { type Settings, Nag } from "./service"; import {type Settings, Nag} from './service';
const data = new SlashCommandBuilder() const data = new SlashCommandBuilder()
.setName("unnag") .setName('unnag')
.setDescription("Remove a nag"); .setDescription('Remove a nag');
async function initialize(settings: Settings) {} async function initialize(settings: Settings) {}
async function execute(interaction: ChatInputCommandInteraction) { async function execute(interaction: ChatInputCommandInteraction) {
// Find all nags for this user // Find all nags for this user
const results = await Nag.findAll({ const results = await Nag.findAll({
where: { userId: interaction.user.id }, where: {userId: interaction.user.id},
}); });
for (const result of results) { for (const result of results) {
await result.destroy(); await result.destroy();

72
index.ts
View File

@@ -1,11 +1,11 @@
import type { Interaction } from "discord.js"; import type {Interaction} from 'discord.js';
import { Client, Events, GatewayIntentBits, MessageFlags } from "discord.js"; import {Client, Events, GatewayIntentBits, MessageFlags} from 'discord.js';
import type { import type {
SlashCommandBuilder, SlashCommandBuilder,
SlashCommandOptionsOnlyBuilder, SlashCommandOptionsOnlyBuilder,
} from "discord.js"; } from 'discord.js';
import { sql, GuildSetting, initDb } from "./database"; import {sql, GuildSetting, initDb} from './database';
const BLITZCRANK_BANNER = ` const BLITZCRANK_BANNER = `
****++++++++++*+++ ****++++++++++*+++
@@ -71,9 +71,9 @@ const client = new Client({
], ],
}); });
import { Routes } from "discord.js"; import {Routes} from 'discord.js';
import { guildId, appId, token, remindersChannelId } from "./config.json"; import {guildId, appId, token, remindersChannelId} from './config.json';
import { REST } from "discord.js"; import {REST} from 'discord.js';
const rest = new REST(); const rest = new REST();
rest.setToken(token); rest.setToken(token);
@@ -84,29 +84,57 @@ interface Command {
initialize: (any) => Promise<void>; initialize: (any) => Promise<void>;
} }
import { Collection } from "discord.js"; import {Collection} from 'discord.js';
const commands = new Collection<string, Command>(); const commands = new Collection<string, Command>();
import PingCommand from "./commands/calendar/ping"; import PingCommand from './commands/calendar/ping';
import RemindCommand from "./commands/calendar/remind"; import RemindCommand from './commands/calendar/remind';
import QuoteCommand from "./commands/quotes/quote"; import QuoteCommand from './commands/quotes/quote';
import NagCommand from "./commands/calendar/nag/nag"; import NagCommand from './commands/calendar/nag/nag';
import UnnagCommand from "./commands/calendar/nag/unnag"; import UnnagCommand from './commands/calendar/nag/unnag';
import CheckinCommand from "./commands/calendar/nag/checkin"; import CheckinCommand from './commands/calendar/nag/checkin';
import {Manager} from './commands/calendar/nag/service';
const nagManager = new Manager({
client: client,
db: sql,
});
nagManager.start();
console.debug(`${remindersChannelId}`); console.debug(`${remindersChannelId}`);
commands.set("ping", PingCommand({ client: client, db: sql })); commands.set('ping', PingCommand({client: client, db: sql}));
commands.set( commands.set(
"remind", 'remind',
RemindCommand({ RemindCommand({
client: client, client: client,
db: sql, db: sql,
publicChannel: remindersChannelId, publicChannel: remindersChannelId,
responseMode: "public", responseMode: 'public',
}),
);
commands.set('quote', QuoteCommand({}));
commands.set(
'nag',
NagCommand({
client: client,
db: sql,
}),
);
commands.set(
'unnag',
UnnagCommand({
client: client,
db: sql,
}),
);
commands.set(
'checkin',
CheckinCommand({
client: client,
db: sql,
}), }),
); );
commands.set("quote", QuoteCommand({}));
async function syncCommands() { async function syncCommands() {
try { try {
@@ -114,7 +142,7 @@ async function syncCommands() {
const _data = await rest.put( const _data = await rest.put(
Routes.applicationGuildCommands(appId, guildId), Routes.applicationGuildCommands(appId, guildId),
{ {
body: commands.mapValues((cmd) => cmd.data.toJSON()), body: commands.mapValues(cmd => cmd.data.toJSON()),
}, },
); );
console.log(`Successfully reloaded slash commands`); console.log(`Successfully reloaded slash commands`);
@@ -138,7 +166,7 @@ client.on(Events.InteractionCreate, async (interaction: Interaction) => {
console.error(error); console.error(error);
if (interaction.replied || interaction.deferred) { if (interaction.replied || interaction.deferred) {
await interaction.followUp({ await interaction.followUp({
content: "There was an error while executing this command", content: 'There was an error while executing this command',
flags: MessageFlags.Ephemeral, flags: MessageFlags.Ephemeral,
}); });
} }
@@ -146,7 +174,7 @@ client.on(Events.InteractionCreate, async (interaction: Interaction) => {
// TODO // TODO
}); });
client.once(Events.ClientReady, async (readyClient) => { client.once(Events.ClientReady, async readyClient => {
await syncCommands(); await syncCommands();
initDb(); // TODO initDb(); // TODO
GuildSetting.sync(); // TODO GuildSetting.sync(); // TODO
@@ -158,7 +186,7 @@ client.once(Events.ClientReady, async (readyClient) => {
}); });
} }
// Print banner // Print banner
for (const ln of BLITZCRANK_BANNER.split("\n")) { for (const ln of BLITZCRANK_BANNER.split('\n')) {
console.log(ln); console.log(ln);
} }
console.log(`Logged in as ${readyClient.user.tag}`); console.log(`Logged in as ${readyClient.user.tag}`);