BotCommands: Don't use user input as JavaScript object keys #603
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Half-Shot
requested changes
Jan 5, 2023
| @@ -38,42 +38,44 @@ export interface BotCommandOptions { | |||
| type BotCommandResult = {status?: boolean, reaction?: string}|undefined; | |||
| type BotCommandFunction = (...args: string[]) => Promise<BotCommandResult>; | |||
|
|
|||
| export type BotCommands = {[prefix: string]: {fn: BotCommandFunction} & BotCommandOptions}; | |||
| export type BotCommands = Map<string, {fn: BotCommandFunction} & BotCommandOptions>; | |||
| export type HelpFunction = (cmdPrefix?: string, categories?: string[], includeTitles?: boolean) => MatrixMessageContent | |||
|
|
|||
| export function compileBotCommands(...prototypes: Record<string, BotCommandFunction>[]): {helpMessage: HelpFunction, botCommands: BotCommands} { | |||
There was a problem hiding this comment.
I do wonder if we should add a test case for BotCommands to just ensure nothing breaks?
There was a problem hiding this comment.
I tried... but this relies on Reflect and decorators (not enabled for the tests director yet), multiple levels of inheritance and using prototypes as JavaScript objects.
All three on their own make code super hard to write unit tests for.
|
@jaller94 In the interests of time, I'll settle for just having you eyeball this and test that nothing is broken on a test instance? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.