feat: Prefix Command Management #85

pdellaert · 2024-10-14T07:25:05Z

Prefix Command Management

Description

Please read https://github.com/pdellaert/fbw-discord-bot-utils/blob/dynamic-command-management/docs/prefix-commands.md for all the fancy details.

NOTE: The cache refresh system will be rewritten to be safer, right now it isn't perfectly safe.

Test Results

I don't know how many hours, but probably good someone takes their own look...

Discord Username

straks

benw202

Really good work! I like the way this has been done.

src/commands/moderation/prefixCommands/functions/addChannelPermission.ts

src/commands/moderation/prefixCommands/functions/addCommand.ts

src/commands/moderation/prefixCommands/functions/addVersion.ts

src/commands/moderation/prefixCommands/functions/modifyCommand.ts

src/commands/moderation/prefixCommands/functions/modifyVersion.ts

src/commands/utils/prefixHelp.ts

src/events/messageCreateHandler.ts

benw202 · 2024-10-16T13:07:57Z

Some further comments as discussed:

When modifying a command name, the mod log embed doesn't show the command description
MongoDB __V not incrementing on an update - intentional?
On timeout of modal it says "You did not provide the necessary content information and the change was not made.". The user may have provided info, but not in time. Is it worth saying that there is a two minute timeout somewhere in the modal description?

benw202 · 2024-10-16T14:20:22Z

Moderator in Prefix Command Cache Update is not a clickable tag. Could make this clickable if we want it to match other mod logs?

pdellaert · 2024-10-17T04:43:06Z

Addressed the review comments, will look at

MongoDB __V not incrementing on an update - intentional?
On timeout of modal it says "You did not provide the necessary content information and the change was not made.". The user may have provided info, but not in time. Is it worth saying that there is a two minute timeout somewhere in the modal description?

Also likely to hide the choice buttons if it is a "fallback-to-GENERIC" if a different unavailable version is requested (either explicit, or by channel default)

pdellaert · 2024-10-17T05:54:09Z

On timeout of modal it says "You did not provide the necessary content information and the change was not made.". The user may have provided info, but not in time. Is it worth saying that there is a two minute timeout somewhere in the modal description?

Can this be done? I don't see a way to add a description to the Modal? Doesn't look like we do it anywhere?

benw202 · 2024-10-18T19:49:08Z

On timeout of modal it says "You did not provide the necessary content information and the change was not made.". The user may have provided info, but not in time. Is it worth saying that there is a two minute timeout somewhere in the modal description?

Can this be done? I don't see a way to add a description to the Modal? Doesn't look like we do it anywhere?

You're right! I saw descriptions somewhere but seems it was only a concept. I guess we will just have to remember that we have a two minute limit. Make sure that people who can add and modify commands write their commands out elsewhere and just copy/paste in.

ExampleWasTaken · 2024-10-19T18:48:58Z

I just gave this a test and thought I'd share what I found. I have not reviewed the code yet because I wanted to understand the functionality first.

All was tested on e95eae2.

To get the important stuff right out of the way:

The bot crashes when trying to set content for an invalid/non-existing version

The rest are just thoughts I had while messing about.

When a custom version is set as a channel default and that version is disabled, nothing is shown.

Example setup with a32nx and a380x being custom versions of the .bg command:

`a380x` is disabled but set as default version for channel A:

Running .bg results in nothing being shown. IMO this should result in the GENERIC version being shown. The presence of the a380x is not leaked as showing the GENERIC version is the default behavior anyway. Additionally, the way it currently works, there is not way to get a list of all available versions.

Commands without content?

Is there any reason why commands can be "empty" i.e. have no content set? IMO there should at least be a GENERIC version of every command.
This will

ensure that users are able to retrieve a list of all available versions
prevents "ghost" commands that exist but have no content and therefore no use

I might be missing something here but I didn't find an explanation for this and thought I'd raise it. :)

Consistent slash command

As it stands right now there are three different slash-commands for this feature:

/prefix-commands
/prefix-command-permissions
/prefix-help
/prefix-commands-cache-update

I think this is pretty inconsistent and confusing to remember (was it /prefix-commands-permissions, /prefix-command-permission or /prefix-command-permissions?).
Instead, I suggest we use a common slash-command /prefix and have everything else be sub commands.

Example:

/prefix categories <...>
/prefix versions <...>
/prefix permissions <...>
/prefix help <...>
/prefix cache <...>

This way, the user can explore all available commands in the Discord client by just typing /prefix . It also reduces the overall slash-commands used and provides a cleaner command structure imo.

I think overall this is looking pretty awesome! Really nice work!

ExampleWasTaken · 2024-10-19T19:44:28Z

Another bug I just found:

Aliases are not unique against command names and aliases of other commands.

Example:

These can all exist at the same time.

Command 1

Name: beginners_guide
Alias: bg

Command 2

Name: bg

Command 3

Name: test
Alias: bg

This results in undefined behavior as there are three possible commands that would all fulfil the conditions to be shown.

pdellaert · 2024-10-20T23:56:13Z

Bunch of changes, most are bug fixes and minor enhancements to make sure that there's no overlap in commands, aliases & versions. Also no empty contents.

Feedback on commands without content: Can't really do anything about it. I can't force setting a GENERIC content, unless we do it during the creation of the command, but would require a bit more work than we have time for right now.

Feeback on different slash commands: As discussed in the channel, Discord has a max length on command definition and subgroup/commands, we would be exceeding it if we put it in one.

Changes since my last comment (4 days ago) pdellaert/fbw-discord-bot-utils@e95eae2...dynamic-command-management

ExampleWasTaken · 2024-10-21T05:08:24Z

That sounds awesome!

Regarding the commands without content, I think that something we can introduce down the line if we want to. Definitely not a showstopper.

benw202 · 2024-10-21T09:05:42Z

That sounds awesome!

Regarding the commands without content, I think that something we can introduce down the line if we want to. Definitely not a showstopper.

Agree on this. There will be a limited amount of people who can add commands so the likelihood of us having rogue empty commands should be none.

* AutoComplete added for categories, versions and command names where appropriate * Added Modal for Content

…l message create handler

…selection for GENERIC versions

* Allowing empty title * Fixing messageCreateHandler in case of unset permissions on command *

…ight event

…returns

* Showing buttons for disabled versions on generic content * Not showing anything if channel default is disabled

* Not properly checking commands and versions * Not prorperly using defer/reply/followUp

…nds. And version aliases do not overlap with commands

…rash

ExampleWasTaken

This is outstanding work! The way this is thought through and structured is more than impressive!

I've said a few things about it on Discord already so here just the most important stuff:

Currently, all commands that list something (version, categories, commands) will fail when there are more than 25 items to list. This is due to Discord's limitation of max 25 fields per embed. I think these commands migth need a paginated embed.

Absolutely awesome stuff!

ExampleWasTaken · 2024-10-22T14:24:06Z

src/commands/moderation/prefixCommands/functions/addCategory.ts

+    const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;
+    if (!modLogsChannel) {


Suggested change

const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;

if (!modLogsChannel) {

let modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS);

if (!modLogsChannel || !modLogsChannel.isTextBased()) {

modLogsChannel = null;

Might be safer to actually check if the channel is a text channel? Especially if we want to offer the codebase to other projects. Then, if it's not a text channel set it to null to prevent accidental attempts to send into a non-text channel.

ExampleWasTaken · 2024-10-22T15:54:17Z

src/commands/moderation/prefixCommands/functions/modifyCategory.ts

+
+const doesNotExistsEmbed = (category: string) => makeEmbed({
+    title: 'Prefix Commands - Modify Category - Does not exist',
+    description: `The prefix command category ${category} does not exists. Can not modify it.`,


Suggested change

description: `The prefix command category ${category} does not exists. Can not modify it.`,

description: `The prefix command category ${category} does not exists. Cannot modify it.`,

"Cannot" is generally more common. I suggest we use that but obviously that's personal preference and I'm happy to leave it as is!

ExampleWasTaken · 2024-10-22T15:56:20Z

src/commands/moderation/prefixCommands/functions/modifyCategory.ts

+    const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;
+    if (!modLogsChannel) {


Suggested change

const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;

if (!modLogsChannel) {

let modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS);

if (!modLogsChannel || !modLogsChannel.isTextBased()) {

modLogsChannel = null;

Might be safer to actually check if the channel is a text channel? Especially if we want to offer the codebase to other projects. Then, if it's not a text channel set it to null to prevent accidental attempts to send into a non-text channel.

ExampleWasTaken · 2024-10-22T16:04:07Z

src/commands/moderation/prefixCommands/functions/deleteCategory.ts

+
+const doesNotExistsEmbed = (category: string) => makeEmbed({
+    title: 'Prefix Commands - Delete Category - Does not exist',
+    description: `The prefix command category ${category} does not exists. Can not delete it.`,


Suggested change

description: `The prefix command category ${category} does not exists. Can not delete it.`,

description: `The prefix command category ${category} does not exists. Cannot delete it.`,

"Cannot" is generally more common. I suggest we use that but obviously that's personal preference and I'm happy to leave it as is!

ExampleWasTaken · 2024-10-22T16:12:03Z

src/commands/moderation/prefixCommands/functions/addCategory.ts

+        await interaction.followUp({ embeds: [noModLogs], ephemeral: true });
+        return;


Suggested change

await interaction.followUp({ embeds: [noModLogs], ephemeral: true });

return;

await interaction.followUp({ embeds: [noModLogs], ephemeral: true });

As discussed, this is just a warning and shouldn't block the creation.

ExampleWasTaken · 2024-10-25T20:51:31Z

src/lib/cache/cacheManager.ts

+    for (const category of PrefixCommandCategories) {
+        // eslint-disable-next-line no-await-in-loop
+        await loadSinglePrefixCommandCategoryToCache(category);
+    }


Suggested change

for (const category of PrefixCommandCategories) {

// eslint-disable-next-line no-await-in-loop

await loadSinglePrefixCommandCategoryToCache(category);

}

await Promise.all(PrefixCommandCategories.map((category) => loadSinglePrefixCommandCategoryToCache(category)));

Nerd level increasing... xD

ExampleWasTaken · 2024-10-25T20:53:49Z

src/lib/cache/cacheManager.ts

+    for (const dbCategory of prefixCommandCategories) {
+        // eslint-disable-next-line no-await-in-loop
+        await loadSinglePrefixCommandCategoryToCache(dbCategory);
+    }


Suggested change

for (const dbCategory of prefixCommandCategories) {

// eslint-disable-next-line no-await-in-loop

await loadSinglePrefixCommandCategoryToCache(dbCategory);

}

await Promise.all(prefixCommandCategories.map((dbCategory) => loadSinglePrefixCommandCategoryToCache(dbCategory)));

Awaiting all the promises...

ExampleWasTaken · 2024-10-25T20:58:57Z

src/lib/cache/cacheManager.ts

+    for (const defaultVersion of PrefixCommandChannelDefaultVersions) {
+        // eslint-disable-next-line no-await-in-loop
+        await loadSinglePrefixCommandChannelDefaultVersionToCache(defaultVersion);
+    }


Suggested change

for (const defaultVersion of PrefixCommandChannelDefaultVersions) {

// eslint-disable-next-line no-await-in-loop

await loadSinglePrefixCommandChannelDefaultVersionToCache(defaultVersion);

}

await Promise.all(

PrefixCommandChannelDefaultVersions

.map((defaultVersion) => loadSinglePrefixCommandChannelDefaultVersionToCache(defaultVersion)),

);

Can't wait till prettier does the formtting for us...

ExampleWasTaken · 2024-10-25T21:02:35Z

src/lib/cache/cacheManager.ts

+    for (const dbChannelDefaultVersion of prefixCommandChannelDefaultVersions) {
+        // eslint-disable-next-line no-await-in-loop
+        await loadSinglePrefixCommandChannelDefaultVersionToCache(dbChannelDefaultVersion);
+    }


Suggested change

for (const dbChannelDefaultVersion of prefixCommandChannelDefaultVersions) {

// eslint-disable-next-line no-await-in-loop

await loadSinglePrefixCommandChannelDefaultVersionToCache(dbChannelDefaultVersion);

}

await Promise.all(

prefixCommandChannelDefaultVersions

.map(

(dbChannelDefaultVersion) => loadSinglePrefixCommandChannelDefaultVersionToCache(dbChannelDefaultVersion),

),

);

Even longer lmao. But I'm always a fan of descriptive names so I rather take that than guessing what a function may do 👍.

ExampleWasTaken · 2024-10-25T21:37:15Z

src/lib/schedulerJobs/refreshInMemoryCache.ts

+        await refreshAllPrefixCommandVersionsCache();
+        await refreshAllPrefixCommandCategoriesCache();
+        await refreshAllPrefixCommandsCache();
+        await refreshAllPrefixCommandChannelDefaultVersionsCache();


These could potentially be refreshed concurrently using Promise.all(), but it is unclear to me if, and if so, how versions and default channel version are dependent on each other. It may be simpler to avoid race conditions and update them sequentially.

pdellaert requested a review from benw202 October 14, 2024 07:25

pdellaert self-assigned this Oct 14, 2024

pdellaert marked this pull request as ready for review October 15, 2024 06:34

benw202 requested changes Oct 16, 2024

View reviewed changes

pdellaert added 16 commits October 22, 2024 20:27

Initial prefix commands management

22f4d96

Splitting into multiple commands

763c6a0

Migrating Schema and adapting Content management

7a21eff

Updating permissions for new schema and fix issues

d4d401f

Adding AutoComplete and Content Modal

b9905bc

* AutoComplete added for categories, versions and command names where appropriate * Added Modal for Content

Adding Default Channel Versions and add autocomplete to everything

96c1c3a

Introducing cache mechanism to keep local cache, manage it and initia…

4a76dfa

…l message create handler

Making cache and command checks case-insensitive

03163ee

Adding a scheduled task to refresh the cache automatically

fc35d7c

Adding Categories and Default Channel Versions to cache

4546bfe

Managing Category cache and Default Version Cache

73ca86e

Adding default channel version parsing

3dd97ce

Refactor cache management to be more intuitive and introduce version …

52a7351

…selection for GENERIC versions

Fixing staging config json

114ed1f

Refactor Permission mechanism

ce78316

Finalizing permission work

7dd6207

pdellaert added 27 commits October 22, 2024 20:28

Fixing bug when there is no CDV set for a channel

152d834

Adding initial documentation for prefix-commands

fb5db69

Refactor cache management for Channel Default Versions

5b867cf

Refactoring cache

a4351c7

Updating docs on cachi auto refresh

984b1db

Adding CHANGELOG entry

2df024c

Disabling autocreate for unnecessary collections

23ce2f6

Fixing bug where initial permissions were not properly set

72fa602

Fixing issues:

035b415

* Allowing empty title * Fixing messageCreateHandler in case of unset permissions on command *

Fixing maximum number of callback items

26973ba

Fix if there's no content at all

d3e0165

Fix boolean handling

98eabc8

Fix: Cache update with additional caches and proper mod output

8076f0b

Fix: Improvements based on review feedback

dc11d6e

Fix: review issues and bug on missing max number of choices

f00ed5c

Change order of cache update to be in line with command

573862d

Fix: Fixing a potential race condition to set the clicked immediately

5bfc280

Fix: Actually fixes the race condition properly by checking for the r…

1b771fb

…ight event

Disabling buttons if it is a fallback to GENERIC version

539eae2

Fix bugs - crash for unexisting version in setContext and missing db …

0b2119b

…returns

Fix bugs:

f26c5ae

* Showing buttons for disabled versions on generic content * Not showing anything if channel default is disabled

Fix bug: Add name and aliases uniqueness

ffd3888

Fix bugs in Content management

551b7eb

* Not properly checking commands and versions * Not prorperly using defer/reply/followUp

Fix: Checking for empty content

556caee

Fix verifying generic does not get created/used for versions or comma…

1ddc66e

…nds. And version aliases do not overlap with commands

Fix bug where if no content for enabled versions was found it could c…

d07d7be

…rash

Clarifying button

b650b38

pdellaert force-pushed the dynamic-command-management branch from 384855f to b650b38 Compare October 23, 2024 03:31

Fix modchannel checks

f3893d0

ExampleWasTaken reviewed Oct 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Prefix Command Management #85

feat: Prefix Command Management #85

pdellaert commented Oct 14, 2024

benw202 left a comment

benw202 commented Oct 16, 2024

benw202 commented Oct 16, 2024

pdellaert commented Oct 17, 2024

pdellaert commented Oct 17, 2024

benw202 commented Oct 18, 2024

ExampleWasTaken commented Oct 19, 2024

ExampleWasTaken commented Oct 19, 2024

pdellaert commented Oct 20, 2024 •

edited

Loading

ExampleWasTaken commented Oct 21, 2024

benw202 commented Oct 21, 2024

ExampleWasTaken left a comment

ExampleWasTaken Oct 22, 2024

ExampleWasTaken Oct 22, 2024

ExampleWasTaken Oct 22, 2024

ExampleWasTaken Oct 22, 2024

ExampleWasTaken Oct 22, 2024

ExampleWasTaken Oct 25, 2024

ExampleWasTaken Oct 25, 2024

ExampleWasTaken Oct 25, 2024

ExampleWasTaken Oct 25, 2024

ExampleWasTaken Oct 25, 2024

		const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;
		if (!modLogsChannel) {

-    const modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS) as TextChannel;
-    if (!modLogsChannel) {
+    let modLogsChannel = interaction.guild.channels.resolve(constantsConfig.channels.MOD_LOGS);
+    if (!modLogsChannel || !modLogsChannel.isTextBased()) {
+        modLogsChannel = null;

	description: `The prefix command category ${category} does not exists. Can not modify it.`,
	description: `The prefix command category ${category} does not exists. Cannot modify it.`,

		await interaction.followUp({ embeds: [noModLogs], ephemeral: true });
		return;

feat: Prefix Command Management #85

Are you sure you want to change the base?

feat: Prefix Command Management #85

Conversation

pdellaert commented Oct 14, 2024

Prefix Command Management

Description

Test Results

Discord Username

benw202 left a comment

Choose a reason for hiding this comment

benw202 commented Oct 16, 2024

benw202 commented Oct 16, 2024

pdellaert commented Oct 17, 2024

pdellaert commented Oct 17, 2024

benw202 commented Oct 18, 2024

ExampleWasTaken commented Oct 19, 2024

When a custom version is set as a channel default and that version is disabled, nothing is shown.

a380x is disabled but set as default version for channel A:

Commands without content?

Consistent slash command

ExampleWasTaken commented Oct 19, 2024

Command 1

Command 2

Command 3

pdellaert commented Oct 20, 2024 • edited Loading

ExampleWasTaken commented Oct 21, 2024

benw202 commented Oct 21, 2024

ExampleWasTaken left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

`a380x` is disabled but set as default version for channel A:

pdellaert commented Oct 20, 2024 •

edited

Loading