WIP: Start of logging
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed

This commit is contained in:
Ethan Lane 2024-03-12 17:42:02 +00:00
parent f40328b795
commit 4a0050eb70
17 changed files with 131 additions and 24 deletions

View file

@ -3,6 +3,7 @@ import { ButtonEvent } from "../type/buttonEvent";
import Inventory from "../database/entities/app/Inventory";
import { CoreClient } from "../client/client";
import { default as eClaim } from "../database/entities/app/Claim";
import AppLogger from "../client/appLogger";
export default class Claim extends ButtonEvent {
public override async execute(interaction: ButtonInteraction) {
@ -13,6 +14,8 @@ export default class Claim extends ButtonEvent {
const droppedBy = interaction.customId.split(" ")[3];
const userId = interaction.user.id;
AppLogger.LogSilly("Button/Claim", `Parameters: cardNumber=${cardNumber}, claimId=${claimId}, droppedBy=${droppedBy}, userId=${userId}`);
await interaction.deferReply();
const claimed = await eClaim.FetchOneByClaimId(claimId);

View file

@ -1,6 +1,7 @@
import { ButtonInteraction } from "discord.js";
import { ButtonEvent } from "../type/buttonEvent";
import InventoryHelper from "../helpers/InventoryHelper";
import AppLogger from "../client/appLogger";
export default class Inventory extends ButtonEvent {
public override async execute(interaction: ButtonInteraction) {
@ -9,6 +10,8 @@ export default class Inventory extends ButtonEvent {
const userid = interaction.customId.split(" ")[1];
const page = interaction.customId.split(" ")[2];
AppLogger.LogSilly("Button/Inventory", `Parameters: userid=${userid}, page=${page}`);
const member = interaction.guild.members.cache.find(x => x.id == userid) || await interaction.guild.members.fetch(userid);
if (!member) {
@ -17,6 +20,8 @@ export default class Inventory extends ButtonEvent {
}
try {
AppLogger.LogVerbose("Button/Inventory", `Generating inventory page ${page} for ${member.user.username} with id ${member.user.id}`);
const embed = await InventoryHelper.GenerateInventoryPage(member.user.username, member.user.id, Number(page));
await interaction.update({
@ -24,7 +29,8 @@ export default class Inventory extends ButtonEvent {
components: [ embed.row ],
});
} catch (e) {
console.error(e);
AppLogger.LogError("Button/Inventory", `Error generating inventory page for ${member.user.username} with id ${member.user.id}: ${e}`);
await interaction.reply("No page for user found.");
}
}

View file

@ -7,6 +7,7 @@ import Inventory from "../database/entities/app/Inventory";
import Config from "../database/entities/app/Config";
import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
import path from "path";
import AppLogger from "../client/appLogger";
export default class Reroll extends ButtonEvent {
public override async execute(interaction: ButtonInteraction) {
@ -16,6 +17,8 @@ export default class Reroll extends ButtonEvent {
}
if (await Config.GetValue("safemode") == "true") {
AppLogger.LogWarn("Button/Reroll", "Safe Mode is active, refusing to send next drop.");
await interaction.reply("Safe Mode has been activated, please resync to continue.");
return;
}
@ -30,6 +33,8 @@ export default class Reroll extends ButtonEvent {
await interaction.deferReply();
try {
AppLogger.LogVerbose("Button/Reroll", `Sending next drop: ${randomCard.card.id} (${randomCard.card.name})`);
const image = readFileSync(path.join(process.env.DATA_DIR!, "cards", randomCard.card.path));
const imageFileName = randomCard.card.path.split("/").pop()!;
@ -51,9 +56,8 @@ export default class Reroll extends ButtonEvent {
});
CoreClient.ClaimId = claimId;
} catch (e) {
console.error(e);
AppLogger.LogError("Button/Reroll", `Error sending next drop for card ${randomCard.card.id}: ${e}`);
await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. (${randomCard.card.id})`);
}

View file

@ -3,11 +3,14 @@ import { ButtonEvent } from "../type/buttonEvent";
import { CoreClient } from "../client/client";
import Inventory from "../database/entities/app/Inventory";
import EmbedColours from "../constants/EmbedColours";
import AppLogger from "../client/appLogger";
export default class Trade extends ButtonEvent {
public override async execute(interaction: ButtonInteraction) {
const action = interaction.customId.split(" ")[1];
AppLogger.LogSilly("Button/Trade", `Parameters: action=${action}`);
switch (action) {
case "accept":
await this.AcceptTrade(interaction);
@ -26,6 +29,8 @@ export default class Trade extends ButtonEvent {
const expiry = interaction.customId.split(" ")[6];
const timeoutId = interaction.customId.split(" ")[7];
AppLogger.LogSilly("Button/Trade/AcceptTrade", `Parameters: giveUserId=${giveUserId}, receiveUserId=${receiveUserId}, giveCardNumber=${giveCardNumber}, receiveCardNumber=${receiveCardNumber}, expiry=${expiry}, timeoutId=${timeoutId}`);
const expiryDate = new Date(expiry);
if (expiryDate < new Date()) {
@ -140,6 +145,8 @@ export default class Trade extends ButtonEvent {
// No need to get expiry date
const timeoutId = interaction.customId.split(" ")[7];
AppLogger.LogSilly("Button/Trade/DeclineTrade", `Parameters: giveUserId=${giveUserId}, receiveUserId=${receiveUserId}, giveCardNumber=${giveCardNumber}, receiveCardNumber=${receiveCardNumber}, timeoutId=${timeoutId}`);
if (interaction.user.id != receiveUserId && interaction.user.id !==giveUserId) {
await interaction.reply("You are not the user who the trade is intended for");
return;

View file

@ -1,8 +1,9 @@
import { Logger, createLogger, format, transports } from "winston";
import { CoreClient } from "./client";
export default class AppLogger {
public static InitialiseLogger(logLevel: string, outputToConsole: boolean): Logger {
public static Logger: Logger;
public static InitialiseLogger(logLevel: string, outputToConsole: boolean) {
const customFormat = format.printf(({ level, message, timestamp, label }) => {
return `${timestamp} [${label}] ${level}: ${message}`;
});
@ -33,30 +34,30 @@ export default class AppLogger {
)}));
}
return logger;
AppLogger.Logger = logger;
}
public static LogError(label: string, message: string) {
CoreClient.Logger.error({ label, message });
AppLogger.Logger.error({ label, message });
}
public static LogWarn(label: string, message: string) {
CoreClient.Logger.warn({ label, message });
AppLogger.Logger.warn({ label, message });
}
public static LogInfo(label: string, message: string) {
CoreClient.Logger.info({ label, message });
AppLogger.Logger.info({ label, message });
}
public static LogVerbose(label: string, message: string) {
CoreClient.Logger.verbose({ label, message });
AppLogger.Logger.verbose({ label, message });
}
public static LogDebug(label: string, message: string) {
CoreClient.Logger.debug({ label, message });
AppLogger.Logger.debug({ label, message });
}
public static LogSilly(label: string, message: string) {
CoreClient.Logger.silly({ label, message });
AppLogger.Logger.silly({ label, message });
}
}

View file

@ -13,7 +13,6 @@ import { Environment } from "../constants/Environment";
import Webhooks from "../webhooks";
import CardMetadataFunction from "../Functions/CardMetadataFunction";
import { SeriesMetadata } from "../contracts/SeriesMetadata";
import { Logger } from "winston";
import AppLogger from "./appLogger";
export class CoreClient extends Client {
@ -29,7 +28,6 @@ export class CoreClient extends Client {
public static Environment: Environment;
public static AllowDrops: boolean;
public static Cards: SeriesMetadata[];
public static Logger: Logger;
public static get commandItems(): ICommandItem[] {
return this._commandItems;
@ -49,7 +47,9 @@ export class CoreClient extends Client {
CoreClient.Environment = Number(process.env.BOT_ENV);
CoreClient.Logger = AppLogger.InitialiseLogger(process.env.BOT_VERBOSE == "true" ? "verbose" : "info", CoreClient.Environment == Environment.Local);
AppLogger.InitialiseLogger(process.env.BOT_VERBOSE == "true" ? "verbose" : "info", CoreClient.Environment == Environment.Local);
AppLogger.LogInfo("Client", "Initialising Client");
CoreClient._commandItems = [];
CoreClient._buttonEvents = [];
@ -58,20 +58,24 @@ export class CoreClient extends Client {
this._util = new Util();
this._webhooks = new Webhooks();
console.log(`Bot Environment: ${CoreClient.Environment}`);
AppLogger.LogInfo("Client", `Environment: ${CoreClient.Environment}`);
CoreClient.AllowDrops = true;
}
public async start() {
if (!process.env.BOT_TOKEN) {
console.error("BOT_TOKEN is not defined in .env");
AppLogger.LogError("Client", "BOT_TOKEN is not defined in .env");
return;
}
await AppDataSource.initialize()
.then(() => console.log("App Data Source Initialised"))
.catch(err => console.error("Error initialising App Data Source", err));
.then(() => AppLogger.LogInfo("Client", "App Data Source Initialised"))
.catch(err => {
AppLogger.LogError("Client", "App Data Source Initialisation Failed");
AppLogger.LogError("Client", err);
throw err;
});
super.on("interactionCreate", this._events.onInteractionCreate);
super.on("ready", this._events.onReady);
@ -96,6 +100,8 @@ export class CoreClient extends Client {
if ((environment & CoreClient.Environment) == CoreClient.Environment) {
CoreClient._commandItems.push(item);
AppLogger.LogVerbose("Client", `Registered Command: ${name}`);
}
}
@ -118,6 +124,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Channel Create Event`);
}
public static RegisterChannelDeleteEvent(fn: (channel: DMChannel | NonThreadGuildBasedChannel) => void) {
@ -139,6 +147,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Channel Delete Event`);
}
public static RegisterChannelUpdateEvent(fn: (channel: DMChannel | NonThreadGuildBasedChannel) => void) {
@ -160,6 +170,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Channel Update Event`);
}
public static RegisterGuildBanAddEvent(fn: (ban: GuildBan) => void) {
@ -181,6 +193,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Ban Add Event`);
}
public static RegisterGuildBanRemoveEvent(fn: (channel: GuildBan) => void) {
@ -202,6 +216,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Ban Remove Event`);
}
public static RegisterGuildCreateEvent(fn: (guild: Guild) => void) {
@ -223,6 +239,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Create Event`);
}
public static RegisterGuildMemberAddEvent(fn: (member: GuildMember) => void) {
@ -244,6 +262,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Member Add Event`);
}
public static RegisterGuildMemberRemoveEvent(fn: (member: GuildMember | PartialGuildMember) => void) {
@ -265,6 +285,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Member Remove Event`);
}
public static GuildMemebrUpdate(fn: (oldMember: GuildMember | PartialGuildMember, newMember: GuildMember) => void) {
@ -286,6 +308,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Guild Member Update Event`);
}
public static RegisterMessageCreateEvent(fn: (message: Message<boolean>) => void) {
@ -307,6 +331,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Message Create Event`);
}
public static RegisterMessageDeleteEvent(fn: (message: Message<boolean> | PartialMessage) => void) {
@ -328,6 +354,8 @@ export class CoreClient extends Client {
MessageUpdate: [],
};
}
AppLogger.LogVerbose("Client", `Registered Message Delete Event`);
}
public static RegisterMessageUpdateEvent(fn: (oldMessage: Message<boolean> | PartialMessage, newMessage: Message<boolean> | PartialMessage) => void) {
@ -349,6 +377,8 @@ export class CoreClient extends Client {
MessageUpdate: [ fn ],
};
}
AppLogger.LogVerbose("Client", `Registered Message Update Event`);
}
public static RegisterButtonEvent(buttonId: string, event: ButtonEvent, environment: Environment = Environment.All) {
@ -360,6 +390,8 @@ export class CoreClient extends Client {
if ((environment & CoreClient.Environment) == CoreClient.Environment) {
CoreClient._buttonEvents.push(item);
AppLogger.LogVerbose("Client", `Registered Button Event: ${buttonId}`);
}
}
}

View file

@ -1,22 +1,25 @@
import { Interaction } from "discord.js";
import ChatInputCommand from "./interactionCreate/ChatInputCommand";
import Button from "./interactionCreate/Button";
import AppLogger from "./appLogger";
export class Events {
public async onInteractionCreate(interaction: Interaction) {
if (!interaction.guildId) return;
if (interaction.isChatInputCommand()) {
AppLogger.LogVerbose("Client", `ChatInputCommand: ${interaction.commandName}`);
ChatInputCommand.onChatInput(interaction);
}
if (interaction.isButton()) {
AppLogger.LogVerbose("Client", `Button: ${interaction.customId}`);
Button.onButtonClicked(interaction);
}
}
// Emit when bot is logged in and ready to use
public onReady() {
console.log("Ready");
AppLogger.LogInfo("Client", "Ready");
}
}

View file

@ -1,5 +1,6 @@
import { ButtonInteraction } from "discord.js";
import { CoreClient } from "../client";
import AppLogger from "../appLogger";
export default class Button {
public static async onButtonClicked(interaction: ButtonInteraction) {
@ -8,14 +9,19 @@ export default class Button {
const item = CoreClient.buttonEvents.find(x => x.ButtonId == interaction.customId.split(" ")[0]);
if (!item) {
AppLogger.LogVerbose("Button", `Event not found: ${interaction.customId}`);
await interaction.reply("Event not found");
return;
}
try {
AppLogger.LogDebug("Button", `Executing ${interaction.customId}`);
item.Event.execute(interaction);
} catch (e) {
console.error(e);
AppLogger.LogError("Button", `Error occurred while executing event: ${interaction.customId}`);
AppLogger.LogError("Button", e as string);
await interaction.reply("An error occurred while executing the event");
}

View file

@ -1,6 +1,7 @@
import { Interaction } from "discord.js";
import { CoreClient } from "../client";
import ICommandItem from "../../contracts/ICommandItem";
import AppLogger from "../appLogger";
export default class ChatInputCommand {
public static async onChatInput(interaction: Interaction) {
@ -13,6 +14,8 @@ export default class ChatInputCommand {
if (!itemForServer) {
if (!item) {
AppLogger.LogVerbose("ChatInputCommand", `Command not found: ${interaction.commandName}`);
await interaction.reply("Command not found");
return;
}
@ -23,9 +26,12 @@ export default class ChatInputCommand {
}
try {
AppLogger.LogDebug("Command", `Executing ${interaction.commandName}`);
itemToUse.Command.execute(interaction);
} catch (e) {
console.error(e);
AppLogger.LogError("ChatInputCommand", `Error occurred while executing command: ${interaction.commandName}`);
AppLogger.LogError("ChatInputCommand", e as string);
await interaction.reply("An error occurred while executing the command");
}

View file

@ -1,6 +1,7 @@
import { Client, REST, Routes, SlashCommandBuilder } from "discord.js";
import EventExecutors from "../contracts/EventExecutors";
import { CoreClient } from "./client";
import AppLogger from "./appLogger";
export class Util {
public loadSlashCommands(client: Client) {
@ -29,6 +30,8 @@ export class Util {
const rest = new REST({ version: "10" }).setToken(process.env.BOT_TOKEN!);
AppLogger.LogVerbose("Util", `REST PUT: ${globalCommandData.flatMap(x => x.name).join(", ")}`);
rest.put(
Routes.applicationCommands(process.env.BOT_CLIENTID!),
{
@ -49,6 +52,8 @@ export class Util {
if (!client.guilds.cache.has(guild)) continue;
AppLogger.LogVerbose("Util", `REST PUT: ${guild} - ${guildCommandData.flatMap(x => x.name).join(", ")}`);
rest.put(
Routes.applicationGuildCommands(process.env.BOT_CLIENTID!, guild),
{

View file

@ -7,6 +7,7 @@ import Inventory from "../database/entities/app/Inventory";
import Config from "../database/entities/app/Config";
import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
import path from "path";
import AppLogger from "../client/appLogger";
export default class Drop extends Command {
constructor() {
@ -24,6 +25,8 @@ export default class Drop extends Command {
}
if (await Config.GetValue("safemode") == "true") {
AppLogger.LogWarn("Commands/Drop", "Safe Mode is active, refusing to send next drop.");
await interaction.reply("Safe Mode has been activated, please resync to continue.");
return;
}
@ -61,7 +64,7 @@ export default class Drop extends Command {
CoreClient.ClaimId = claimId;
} catch (e) {
console.error(e);
AppLogger.LogError("Commands/Drop", `Error sending next drop for card ${randomCard.card.id}: ${e}`);
await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. (${randomCard.card.id})`);
}

View file

@ -4,6 +4,7 @@ import { ExecException, exec } from "child_process";
import { CoreClient } from "../client/client";
import Config from "../database/entities/app/Config";
import CardMetadataFunction from "../Functions/CardMetadataFunction";
import AppLogger from "../client/appLogger";
export default class Gdrivesync extends Command {
constructor() {
@ -32,19 +33,28 @@ export default class Gdrivesync extends Command {
CoreClient.AllowDrops = false;
AppLogger.LogInfo("Commands/GDriveSync", "Syncing google drive to the bot");
exec(`rclone sync card-drop-gdrive: ${process.env.DATA_DIR}/cards`, async (error: ExecException | null) => {
if (error) {
AppLogger.LogError("Commands/GDriveSync", `Error while running sync command: ${error.code}, ${error.message}`);
AppLogger.LogWarn("Commands/GDriveSync", "Safe mode activated");
await interaction.editReply(`Error while running sync command. Safe Mode has been activated. Code: ${error.code}`);
await Config.SetValue("safemode", "true");
} else {
const result = await CardMetadataFunction.Execute(true);
if (result.IsSuccess) {
AppLogger.LogInfo("Commands/GDriveSync", "Synced successfully");
await interaction.editReply("Synced successfully.");
CoreClient.AllowDrops = true;
await Config.SetValue("safemode", "false");
} else {
AppLogger.LogError("Commands/GDriveSync", `Error while running sync command: ${result.ErrorMessage}`);
await interaction.editReply(`Sync failed \`\`\`${result.ErrorMessage}\`\`\``);
}
}

View file

@ -4,6 +4,7 @@ import { CoreClient } from "../client/client";
import Config from "../database/entities/app/Config";
import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
import Inventory from "../database/entities/app/Inventory";
import AppLogger from "../client/appLogger";
export default class Give extends Command {
constructor() {
@ -46,6 +47,8 @@ export default class Give extends Command {
const cardNumber = interaction.options.get("cardnumber", true);
const user = interaction.options.getUser("user", true);
AppLogger.LogSilly("Commands/Give", `Parameters: cardNumber=${cardNumber.value}, user=${user.id}`);
const card = CardDropHelperMetadata.GetCardByCardNumber(cardNumber.value!.toString());
if (!card) {

View file

@ -1,6 +1,7 @@
import { CommandInteraction, SlashCommandBuilder } from "discord.js";
import { Command } from "../type/command";
import InventoryHelper from "../helpers/InventoryHelper";
import AppLogger from "../client/appLogger";
export default class Inventory extends Command {
constructor() {
@ -23,6 +24,8 @@ export default class Inventory extends Command {
const page = interaction.options.get("page");
const user = interaction.options.getUser("user") || interaction.user;
AppLogger.LogSilly("Commands/Inventory", `Parameters: page=${page?.value}, user=${user.id}`);
try {
let pageNumber = 0;

View file

@ -2,6 +2,7 @@ import { CacheType, CommandInteraction, PermissionsBitField, SlashCommandBuilder
import { Command } from "../type/command";
import Config from "../database/entities/app/Config";
import CardMetadataFunction from "../Functions/CardMetadataFunction";
import AppLogger from "../client/appLogger";
export default class Resync extends Command {
constructor() {
@ -23,6 +24,8 @@ export default class Resync extends Command {
return;
}
AppLogger.LogInfo("Commands/Resync", "Resyncing database");
const result = await CardMetadataFunction.Execute(true);
if (result) {
@ -34,6 +37,8 @@ export default class Resync extends Command {
}
await interaction.reply("Resynced database.");
} else {
AppLogger.LogWarn("Commands/Resync", "Resync failed, safe mode activated");
await interaction.reply("Resync failed, safe mode has been activated until successful resync.");
}
}

View file

@ -3,6 +3,7 @@ import { Command } from "../type/command";
import Inventory from "../database/entities/app/Inventory";
import { CoreClient } from "../client/client";
import EmbedColours from "../constants/EmbedColours";
import AppLogger from "../client/appLogger";
export default class Trade extends Command {
constructor() {
@ -33,6 +34,8 @@ export default class Trade extends Command {
const give = interaction.options.get("give")!;
const receive = interaction.options.get("receive")!;
AppLogger.LogSilly("Commands/Trade", `Parameters: user=${user.id}, give=${give.value}, receive=${receive.value}`);
const giveItemEntity = await Inventory.FetchOneByCardNumberAndUserId(interaction.user.id, give.value!.toString());
const receiveItemEntity = await Inventory.FetchOneByCardNumberAndUserId(user.id, receive.value!.toString());
@ -102,6 +105,8 @@ export default class Trade extends Command {
}
private async autoDecline(interaction: CommandInteraction, giveUsername: string, receiveUsername: string, giveCardNumber: string, receiveCardNumber: string, giveCardName: string, receiveCardName: string) {
AppLogger.LogSilly("Commands/Trade/AutoDecline", `Auto declining trade between ${giveUsername} and ${receiveUsername}`);
const tradeEmbed = new EmbedBuilder()
.setTitle("Trade Expired")
.setDescription(`Trade initiated between ${receiveUsername} and ${giveUsername}`)

View file

@ -5,6 +5,7 @@ import { readFileSync } from "fs";
import path from "path";
import Inventory from "../database/entities/app/Inventory";
import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
import AppLogger from "../client/appLogger";
export default class View extends Command {
constructor() {
@ -23,6 +24,8 @@ export default class View extends Command {
public override async execute(interaction: CommandInteraction) {
const cardNumber = interaction.options.get("cardnumber");
AppLogger.LogSilly("Commands/View", `Parameters: cardNumber=${cardNumber?.value}`);
if (!cardNumber || !cardNumber.value) {
await interaction.reply("Card number is required.");
return;
@ -46,6 +49,8 @@ export default class View extends Command {
try {
image = readFileSync(path.join(process.env.DATA_DIR!, "cards", card.path));
} catch {
AppLogger.LogError("Commands/View", `Unable to fetch image for card ${card.id}.`);
await interaction.reply(`Unable to fetch image for card ${card.id}.`);
return;
}
@ -65,7 +70,7 @@ export default class View extends Command {
files: [ attachment ],
});
} catch (e) {
console.error(e);
AppLogger.LogError("Commands/View", `Error sending view for card ${card.id}: ${e}`);
if (e instanceof DiscordAPIError) {
await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. Code: ${e.code}.`);