From 5defb682c195f37b4431c3438265bb7dcff599cf Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Sat, 17 Aug 2024 17:26:31 +0100 Subject: [PATCH] Update view command to use fuzzy search instead of direct card number (#340) - Install `fuse.js` package to allow for fuzzy finding - Update the `/view` command to use fuzzy search by name instead of the card number - Add pagination for the command via the `View` button event #154 Reviewed-on: https://git.vylpes.xyz/External/card-drop/pulls/340 Reviewed-by: VylpesTester Co-authored-by: Ethan Lane Co-committed-by: Ethan Lane --- .env.example | 1 + package.json | 1 + src/buttonEvents/View.ts | 25 +++++++++++ src/commands/view.ts | 74 +++++++-------------------------- src/helpers/CardSearchHelper.ts | 62 +++++++++++++++++++++++++++ src/registry.ts | 2 + yarn.lock | 5 +++ 7 files changed, 112 insertions(+), 58 deletions(-) create mode 100644 src/buttonEvents/View.ts create mode 100644 src/helpers/CardSearchHelper.ts diff --git a/.env.example b/.env.example index 00a861f..c260a7d 100644 --- a/.env.example +++ b/.env.example @@ -32,6 +32,7 @@ DB_AUTH_PASS= DB_SYNC= DB_LOGGING= DB_DATA_LOCATION=./.temp/database +DB_ROOT_HOST=0.0.0.0 DB_CARD_FILE=:memory: diff --git a/package.json b/package.json index e213df9..c18a18f 100644 --- a/package.json +++ b/package.json @@ -37,6 +37,7 @@ "discord.js": "^14.15.3", "dotenv": "^16.0.0", "express": "^4.18.2", + "fuse.js": "^7.0.0", "glob": "^10.3.10", "jest": "^29.0.0", "jest-mock-extended": "^3.0.0", diff --git a/src/buttonEvents/View.ts b/src/buttonEvents/View.ts new file mode 100644 index 0000000..8c133ba --- /dev/null +++ b/src/buttonEvents/View.ts @@ -0,0 +1,25 @@ +import {ButtonInteraction} from "discord.js"; +import {ButtonEvent} from "../type/buttonEvent.js"; +import CardSearchHelper from "../helpers/CardSearchHelper.js"; + +export default class View extends ButtonEvent { + public override async execute(interaction: ButtonInteraction) { + const page = interaction.customId.split(" ")[1]; + const query = interaction.customId.split(" ").splice(1).join(" "); + + await interaction.deferUpdate(); + + const searchResult = await CardSearchHelper.GenerateSearchPage(query, interaction.user.id, Number(page)); + + if (!searchResult) { + await interaction.followUp("No results found"); + return; + } + + await interaction.editReply({ + embeds: [ searchResult.embed ], + components: [ searchResult.row ], + files: [ searchResult.attachment ], + }); + } +} diff --git a/src/commands/view.ts b/src/commands/view.ts index ce6f9cb..aff1ef5 100644 --- a/src/commands/view.ts +++ b/src/commands/view.ts @@ -1,11 +1,7 @@ -import { AttachmentBuilder, CommandInteraction, DiscordAPIError, SlashCommandBuilder } from "discord.js"; +import { CommandInteraction, SlashCommandBuilder } from "discord.js"; import { Command } from "../type/command"; -import { CoreClient } from "../client/client"; -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"; +import CardSearchHelper from "../helpers/CardSearchHelper"; export default class View extends Command { constructor() { @@ -16,67 +12,29 @@ export default class View extends Command { .setDescription("View a specific command") .addStringOption(x => x - .setName("cardnumber") - .setDescription("The card number to view") + .setName("name") + .setDescription("The card name to search for") .setRequired(true)); } public override async execute(interaction: CommandInteraction) { - const cardNumber = interaction.options.get("cardnumber"); + const name = interaction.options.get("name", true); - AppLogger.LogSilly("Commands/View", `Parameters: cardNumber=${cardNumber?.value}`); - - if (!cardNumber || !cardNumber.value) { - await interaction.reply("Card number is required."); - return; - } - - const card = CoreClient.Cards - .flatMap(x => x.cards) - .find(x => x.id == cardNumber.value); - - if (!card) { - await interaction.reply("Card not found."); - return; - } - - const series = CoreClient.Cards - .find(x => x.cards.includes(card))!; - - let image: Buffer; - const imageFileName = card.path.split("/").pop()!; - - 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; - } + AppLogger.LogSilly("Commands/View", `Parameters: name=${name.value}`); await interaction.deferReply(); - const attachment = new AttachmentBuilder(image, { name: imageFileName }); + const searchResult = await CardSearchHelper.GenerateSearchPage(name.value!.toString(), interaction.user.id, 0); - const inventory = await Inventory.FetchOneByCardNumberAndUserId(interaction.user.id, card.id); - const quantityClaimed = inventory ? inventory.Quantity : 0; - - const embed = CardDropHelperMetadata.GenerateDropEmbed({ card, series }, quantityClaimed, imageFileName); - - try { - await interaction.editReply({ - embeds: [ embed ], - files: [ attachment ], - }); - } catch (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}.`); - } else { - await interaction.editReply("Unable to send next drop. Please try again, and report this if it keeps happening. Code: UNKNOWN."); - } + if (!searchResult) { + await interaction.editReply("No results found"); + return; } + + await interaction.editReply({ + embeds: [ searchResult.embed ], + components: [ searchResult.row ], + files: [ searchResult.attachment ], + }); } } \ No newline at end of file diff --git a/src/helpers/CardSearchHelper.ts b/src/helpers/CardSearchHelper.ts new file mode 100644 index 0000000..c0f6bd5 --- /dev/null +++ b/src/helpers/CardSearchHelper.ts @@ -0,0 +1,62 @@ +import {ActionRowBuilder, AttachmentBuilder, ButtonBuilder, ButtonStyle, EmbedBuilder} from "discord.js"; +import Fuse from "fuse.js"; +import {CoreClient} from "../client/client.js"; +import CardDropHelperMetadata from "./CardDropHelperMetadata.js"; +import Inventory from "../database/entities/app/Inventory.js"; +import {readFileSync} from "fs"; +import path from "path"; +import AppLogger from "../client/appLogger.js"; + +interface ReturnedPage { + embed: EmbedBuilder, + row: ActionRowBuilder, + attachment: AttachmentBuilder, +} + +export default class CardSearchHelper { + public static async GenerateSearchPage(query: string, userid: string, page: number): Promise { + const fzf = new Fuse(CoreClient.Cards.flatMap(x => x.cards), { keys: ["name"] }); + const entries = fzf.search(query); + + const entry = entries[page]; + + if (!entry) return undefined; + + const card = CardDropHelperMetadata.GetCardByCardNumber(entry.item.id); + + if (!card) return undefined; + + let image: Buffer; + const imageFileName = card.card.path.split("/").pop()!; + + try { + image = readFileSync(path.join(process.env.DATA_DIR!, "cards", card.card.path)); + } catch { + AppLogger.LogError("Commands/View", `Unable to fetch image for card ${card.card.id}.`); + + return undefined; + } + + const attachment = new AttachmentBuilder(image, { name: imageFileName }); + + const inventory = await Inventory.FetchOneByCardNumberAndUserId(userid, card.card.id); + const quantityClaimed = inventory?.Quantity ?? 0; + + const embed = CardDropHelperMetadata.GenerateDropEmbed(card, quantityClaimed, imageFileName); + + const row = new ActionRowBuilder() + .addComponents( + new ButtonBuilder() + .setCustomId(`view ${page - 1} ${query}`) + .setLabel("Previous") + .setStyle(ButtonStyle.Primary) + .setDisabled(page == 0), + new ButtonBuilder() + .setCustomId(`view ${page + 1} ${query}`) + .setLabel("Next") + .setStyle(ButtonStyle.Primary) + .setDisabled(page + 1 == entries.length)); + + return { embed, row, attachment }; + } +} diff --git a/src/registry.ts b/src/registry.ts index 86b2b68..20787af 100644 --- a/src/registry.ts +++ b/src/registry.ts @@ -27,6 +27,7 @@ import Reroll from "./buttonEvents/Reroll"; import SacrificeButtonEvent from "./buttonEvents/Sacrifice"; import SeriesEvent from "./buttonEvents/Series"; import TradeButtonEvent from "./buttonEvents/Trade"; +import ViewButtonEvent from "./buttonEvents/View"; export default class Registry { public static RegisterCommands() { @@ -57,5 +58,6 @@ export default class Registry { CoreClient.RegisterButtonEvent("sacrifice", new SacrificeButtonEvent()); CoreClient.RegisterButtonEvent("series", new SeriesEvent()); CoreClient.RegisterButtonEvent("trade", new TradeButtonEvent()); + CoreClient.RegisterButtonEvent("view", new ViewButtonEvent()); } } \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 5bba916..c743923 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3152,6 +3152,11 @@ function-bind@^1.1.2: resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== +fuse.js@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-7.0.0.tgz#6573c9fcd4c8268e403b4fc7d7131ffcf99a9eb2" + integrity sha512-14F4hBIxqKvD4Zz/XjDc3y94mNZN6pRv3U13Udo0lNLCWRBUsrMv2xwcF/y/Z5sV6+FQW+/ow68cHpm4sunt8Q== + gauge@^3.0.0: version "3.0.2" resolved "https://registry.yarnpkg.com/gauge/-/gauge-3.0.2.tgz#03bf4441c044383908bcfa0656ad91803259b395"