Autocomplete handler is not called on subcommands

[codemasher]

Environment

• PHP Version:
  • 8.4.8
• DiscordPHP Version:
  • 10.36.7

Describe the bug
The autocomplete handler is not properly called when the called command is a subcommand. Autocomplete works perfectly fine on commands without subcommands.

To Reproduce
See below.

Expected behavior
See below.

Additional context
I've tracked down the issue to this method, where I var_dump-ed the $option->focused value and it seemed to have not properly assigned in the options instance:

DiscordPHP/src/Discord/WebSockets/Events/InteractionCreate.php

Lines 110 to 117 in 9018330

	if ($subCommand = $command->getSubCommand($option->name)) {
	if ($option->focused) {
	return $subCommand->suggest($interaction);
	}
	if (! empty($option->options)) {
	return $this->checkCommand($subCommand, $option->options, $interaction);
	}
	} elseif ($option->focused) {

The option value is focused => true as expected and the $subCommand->suggest(...) should be called properly, but the call to $option->focused returns null - I'm not sure where exactly to fix this.

object(Discord\Parts\Interactions\Request\Option)#118 (3) {
  ["attributes"]=>
  array(3) {
    ["name"]=>
    string(3) "set"
    ["type"]=>
    int(1)
    ["options"]=>
    array(1) {
      [0]=>
      object(stdClass)#315 (4) {
        ["value"]=>
        string(0) ""
        ["type"]=>
        int(3)
        ["name"]=>
        string(2) "id"
        ["focused"]=>
        bool(true)
      }
    }
  }
  ["created"]=>
  &bool(true)
  ["class"]=>
  string(41) "Discord\Parts\Interactions\Request\Option"
}

[valzargaming]

$option->focused is correctly null because it's not set at the top-level. It's the part after which should be checking it. Were you able to see if the following was triggered?

if (! empty($option->options)) {
    return $this->checkCommand($subCommand, $option->options, $interaction);
}

[codemasher]

I checked this one too and it didn't run into this either.

btw. it would be really helpful if the incoming autocomplete callback including its values would be logged as soon as it comes in - that would have saved me a bit of a headache. At first I thought the autocomplete callback wasn't even registered, so I dug all the way through (which prompted me to overhaul the register methods in a similar way as in dc4b576)

[valzargaming]

Could you try this again with 10.36.8? I'm wondering if the empty check was running into issues with options being a collection and not a traditional array.

[codemasher]

Ok, that seems to do something - when in doubt, it's always empty().

Which brings me to the next issue, the registering of command- and subcommand handlers.

From what I understand, these blocks of code should be equivalent:

Register main and subcommands individually

$this->registeredCommand = $this->discord->listenCommand($this::NAME, $this->execute(...), $this->autocomplete(...));

foreach(self::SUBCOMMANDS as $subcommand){
	$this->registeredCommand->addSubCommand($subcommand, $this->execute(...), $this->autocomplete(...));
}

Combined call for main and subcommands

$this->registeredCommand = $this->discord->listenCommand([$this::NAME, ...self::SUBCOMMANDS], $this->execute(...), $this->autocomplete(...));

With the difference being that the first block leaves me the option to register different handlers for each subcommand, right? Because right now it doesn't. (give me a minute, I'll see if my register overhaul makes a difference)

[valzargaming]

Sorry for the delay in response, I'm quite sick right now and unable to properly test things at the moment. Were you able to test your PR to confirm if it works?

[codemasher]

Oh don't worry, take your time and get well soon!

The changes in my PR do work as expected, but y'all might want to check back, so that it doesn't break anything unexpectedly.

[codemasher]

Oh also i noticed that the boolean return value of neither, the InteractionCreate::checkCommand() nor RegisteredCommand::suggest() is used or checked here:

DiscordPHP/src/Discord/WebSockets/Events/InteractionCreate.php

Lines 87 to 91 in d935e7a

	if (isset($this->discord->application_commands[$command->name])) {
	$interaction instanceof ApplicationCommand
	? $this->discord->application_commands[$command->name]->execute($command->options ?? [], $interaction)
	: $this->checkCommand($this->discord->application_commands[$command->name], $command->options, $interaction);
	}

This would have revealed the issue too. Actually, both of these methods could be void, and you could throw in the checkCommand() method when there's an autocomplete action expected but no associated value is found.

[oliverschloebe]

getting this error with subcommands

Unhandled promise rejection with LogicException: The command birthday already exists. in vendor/team-reflex/discord-php/src/Discord/Discord.php:1945

listening to the commands with
$discord->listenCommand(['birthday', 'get'], function () ...
$discord->listenCommand(['birthday', 'set'], function () ...

[codemasher]

Hmm, I'm thinking about removing the throw entirely in the proposed change #1414 as it doesn't make much sense there anyway. Instead just checking if the base command not already exists and create it if necessary should suffice.

[valzargaming]

The initial issue is now confirmed to have been resolved with 10.36.8, so I'm closing this issue accordingly. #1414 seems to be a breaking change for at least some users, but I'm not going to act on it at the moment.

[oliverschloebe]

Current master is confirmed fixed for me using sub commands.