Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(SlashCommandBuilder): improve message when missing required params #9468

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+25 −2
Open

chore(SlashCommandBuilder): improve message when missing required params #9468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2649cfb
chore(SlashCommandBuilder): add tests for missing required parameters
wwselleck Apr 28, 2023
f8fdd34
chore(SlashCommandBuilder): improve message when missing required params
wwselleck Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/builders/__tests__/interactions/SlashCommands/SlashCommands.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,16 @@ describe('Slash Commands', () => {
),
).not.toThrowError();
});

test('GIVEN missing required parameters THEN throw error', () => {
expect(() => SlashCommandAssertions.validateRequiredParameters(null, 'My name is missing', [])).toThrowError(
'Required parameter "name" is missing',
);

expect(() =>
SlashCommandAssertions.validateRequiredParameters('my-description-is-missing', null, []),
).toThrowError('Required parameter "description" is missing');
});
});

describe('SlashCommandBuilder', () => {
Expand Down
17 changes: 15 additions & 2 deletions packages/builders/src/interactions/slashCommands/Assertions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ import type { ToAPIApplicationCommandOptions } from './SlashCommandBuilder.js';
import type { SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder } from './SlashCommandSubcommands.js';
import type { ApplicationCommandOptionBase } from './mixins/ApplicationCommandOptionBase.js';

export class MissingRequiredParameterError extends Error {
public constructor(missingParameter: string) {
super(`Required parameter "${missingParameter}" is missing`);
}
}
Comment on lines +8 to +12
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to create this (and make the function return non-shapeshift errors), you can use the MissingPropertyError error class from @sapphire/shapeshift, which is exported.

Using the aforementioned class:

import { MissingPropertyError } from '@sapphire/shapeshift';

throw new MissingPropertyError('name');

const namePredicate = s.string
.lengthGreaterThanOrEqual(1)
.lengthLessThanOrEqual(32)
Expand Down Expand Up @@ -35,14 +40,22 @@ export function validateMaxOptionsLength(options: unknown): asserts options is T
}

export function validateRequiredParameters(
name: string,
description: string,
name: string | undefined,
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

name and description are casted as non-undefined on SlashCommandBuilder, but I figure they should be treated as potentially undefined wherever they can be, since they can be undefined.

description: string | undefined,
options: ToAPIApplicationCommandOptions[],
) {
// Assert name matches all conditions
if (!name) {
throw new MissingRequiredParameterError('name');
}

validateName(name);

// Assert description conditions
if (!description) {
throw new MissingRequiredParameterError('description');
}

validateDescription(description);

// Assert options conditions
Expand Down