I don't want `default` scope without default `handler` 🌚

[PonomareVlad]

commands/src/command.ts

Lines 151 to 162 in 6653e2a

	if (!handler) {
	handler = async (_ctx: Context, next: NextFunction) => await next();
	this._hasHandler = false;
	} else this._hasHandler = true;
	this._options = { ...this._options, ...options };
	if (this._options.prefix?.trim() === "") this._options.prefix = "/";
	this._languages.set("default", { name: name, description });
	if (handler) {
	this.addToScope({ type: "default" }, handler);
	}
	return this;

 if (!handler) { // 1
   handler = async (_ctx: Context, next: NextFunction) => await next();
 } 

 // ...

 if (handler) { // 2
   this.addToScope({ type: "default" }, handler);
 } 

What ?

[PonomareVlad]

@roziscoding @carafelix I propose to discuss this problem, as it looks like something broken and it will definitely affect users:

Notice that the command method could receive the handler too.
If you give it a handler, that handler will apply to the default scope of that command.
Calling addToScope on that command will then add a new handler, which will be filtered for that scope.
Take a look at this example.

https://github.com/grammyjs/website/blob/6ad4f27f40dc1c71fc7f7855616fe62ef8e4356a/site/docs/plugins/commands.md?plain=1#L357-L360

[carafelix]

First of all, thanks for checking up the plugin! It really warms my hearth.

iirc: that specific piece of code is there for people who just want to use the plugin to manage the client command menu but use any other way for handling the commands logic itself. (which sounds awkward, but is not actually 0 hahaha multiple people asked for that in the chat group. Most of them had already in place a complex command logic, which didn't want to rework or was super specific to their use case, and installed the plugin just for the menu) ._hasHandler is there just to indicate the lack handler while inspecting/debugging, it is not used in the logic anywhere.

I mean, this "could" get reworked, but at the time it was the most simple way to add that feature without forcing a major version.

But also, and more importantly, if someone would register a command without a default handler but also does not register any other in any scope... that would be more breaking... since the whole plugin is build around checking upon the scopes and transforming that data into actual BotCommands

Imo, as bad as it looks codewise, is not a bad decision in regards of the user nor the plugin inner logic.

In theory it could get reworked, but within a major plugin rework, moving out about building it around scopes, since we NEED at least a single scope for registering any data.

Could you point an actual benefit besides the aesthetically unpleasant part? (which is still valid)

Thanks again for checking it up 👍

[roziscoding]

@carafelix the issue is that, if a user defines a command without specifying a handler, that command will automatically be added to the default scope. I don't remember if that's desired, but it seems wrong, since there's no way of removing it from that scope later

[PonomareVlad]

Thx for responses!

In my case, I just want this:

export const commands = new CommandGroup()

commands
    .command('broadcast', 'Send broadcast to all users')
    .addToScope({ type: 'chat', chat_id }, broadcast)

// ...

await commands.setCommands(bot) // sets command for default scope too (bug)

But also i need to do this:

await commands.setCommands(bot) // sets command for default scope too (bug)
await bot.api.deleteMyCommands({ scope: { type: 'default' } }) // unset all default scope commands (fix)

Or even this:

const broadcastCommand = commands
    .command('broadcast', 'Send broadcast to all users')
    .addToScope({ type: 'chat', chat_id }, broadcast)

const rejectDefaultScope = scope => scope.type !== 'default'

broadcastCommand._scopes = broadcastCommand.scopes.filter(rejectDefaultScope) // unset default scope for command (fix)

[carafelix]

Thanks for putting it very clear. I thought we already solve this very same issue before, looks like we didn't lol

[dngpng]

The current API and docs does not make it very clear the default handler might exist when i attempted to create a group-specific command that is supposed to be invisible for others:

export const commands = new CommandGroup()

commands
    .command('foo', 'team specific command')
    .addToScope({ type: 'chat', chat_id: '<team group id>' }, fooCommandHandler)

await commands.setCommands(bot); // after this, the command '/foo' is available everywhere.

And somehow I don't see the fooCommandHandler get called even if I trigger the command in the team group. (The handler is triggered if I do not restrict the scope.)