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

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

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 and others added 24 commits October 26, 2024 23:42

Adding mod channel check suggestion

2276f75

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Language fix

6b533a2

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

840eca6

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

209c32b

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Language fix

426dffc

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

96939d5

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Language fix

e625074

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

75afd64

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding language suggestion

f3cb925

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

8c3a21e

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

01916f9

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

48eb504

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

966f2d9

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Adding mod channel check suggestion

27687cd

Co-authored-by: ExampleWasTaken <58574351+ExampleWasTaken@users.noreply.github.com>

Updating Mod log checks and clean up some imports

5675afd

Increasing max lengths to be safe

a267ba9

Fix bug on length, max 4000. Fix bug on filter

0361f63

Improving type checks

1ff3895

Removing useless code

5e88bf3

Moving to enum for prefixes

8298679

Fixing typos

afa2a93

Migrating all possible loops to Promise.all

cf72e94

Better to hard type

41077a5

Optimizing cache updates in parallel

993766a

ExampleWasTaken mentioned this pull request Oct 27, 2024

refactor: lint and styling overhaul #77

Draft

pdellaert added 2 commits October 28, 2024 08:44

Limiting list outputs to 20 max

f384353

Correcting changelog

1d2b4bc

benw202 approved these changes Oct 28, 2024

View reviewed changes

benw202 merged commit e5f5a12 into flybywiresim:staging Oct 28, 2024
3 checks passed

ExampleWasTaken added a commit to ExampleWasTaken/discord-bot-utils that referenced this pull request Oct 29, 2024

fix prettier errors introduced in flybywiresim#85 (expected)

4dff288

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

feat: Prefix Command Management #85

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

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

pdellaert commented Oct 20, 2024 •

edited

Loading