Globally override return type for a method based on argument value

[Chi-teck]

Problem

UndefinedInterfaceMethod
Symfony\Component\Console\Helper\HelperInterface::ask does not exist (see https://psalm.dev/181)
$answer= $this->getHelper('question')->ask($input, $output, $question);

Workaround

I know, it can be handled like follows, but it is a bit annoying and makes the code too verbose.

/** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */
$helper = $this->getHelper('question');
$answer = $helper->ask($input, $output, $question);

Question

Is there a way to establish return types once and for all?
Here is an example of how it works in PhpStorm.

<?php

namespace PHPSTORM_META {

  override(
    \Symfony\Component\Console\Helper\HelperSet::get(),
    map([
      'question' =>\Symfony\Component\Console\Helper\QuestionHelper::class,
      'process' =>\Symfony\Component\Console\Helper\ProcessHelper::class,
    ]),
  );

}

[psalm-github-bot]

Hey @Chi-teck, can you reproduce the issue on https://psalm.dev ?

[weirdan]

Psalm is supposed to read phpstorm.meta files:

psalm/src/Psalm/Internal/PhpVisitor/ReflectorVisitor.php

Lines 513 to 526 in 255a152

	if ($this->codebase->register_stub_files
	&& $node->name
	&& $node->name->parts === ['PHPSTORM_META']
	) {
	foreach ($node->stmts as $meta_stmt) {
	if ($meta_stmt instanceof PhpParser\Node\Stmt\Expression
	&& $meta_stmt->expr instanceof PhpParser\Node\Expr\FuncCall
	&& $meta_stmt->expr->name instanceof PhpParser\Node\Name
	&& $meta_stmt->expr->name->parts === ['override']
	) {
	PhpStormMetaScanner::handleOverride($meta_stmt->expr->getArgs(), $this->codebase);
	}
	}
	}

[Chi-teck]

Seems it reads. I see the following in the debug output.

Parsing /var/www/project//.phpstorm.meta.php
Deep scanning /var/www/project//.phpstorm.meta.php

However, it still produces UndefinedInterfaceMethod errors, while PhpStorm defines correct types for these helpers.

[weirdan]

while PhpStorm defines correct types for these helpers.

What's the phpstorm.meta definition for $this->getHelper() (whatever $this is)?

[Chi-teck]

@weirdan I am not sure I understood you. The phpstorm.meta.php is in the issue summary.
$this is an instance of Symfony Console command class. All Symfony commands has this method as it defined in the base class.

https://github.com/symfony/symfony/blob/v6.2.0-RC1/src/Symfony/Component/Console/Command/Command.php#L689

[weirdan]

Your phpstorm.meta overrides HelperSet::get() return type, but you're calling Command::getHelper(). You would need to override the signature of Command::getHelper() separately.

[Chi-teck]

@weirdan Sorry missed this. There is an another override statement in that file.
Here is the full example.
https://github.com/Chi-teck/drupal-code-generator/blob/3.x/.phpstorm.meta.php

[weirdan]

It seems we currently require you to specify the argument offset the mapping is based on:

psalm/src/Psalm/Internal/Scanner/PhpStormMetaScanner.php

Lines 92 to 93 in 45ed177

	&& $identifier->getArgs()
	&& $identifier->getArgs()[0]->value instanceof PhpParser\Node\Scalar\LNumber

So it would work if you did the override like this:

  override(
    \Symfony\Component\Console\Command\Command::getHelper(0), // <==== note the argument offset
    map([
      'service_info' => \DrupalCodeGenerator\Helper\Drupal\ServiceInfo::class,
      'module_info' => \DrupalCodeGenerator\Helper\Drupal\ModuleInfo::class,
      'theme_info' => \DrupalCodeGenerator\Helper\Drupal\ThemeInfo::class,
      'hook_info' => \DrupalCodeGenerator\Helper\Drupal\HookInfo::class,
      'route_info' => \DrupalCodeGenerator\Helper\Drupal\RouteInfo::class,
      'permission_info' => \DrupalCodeGenerator\Helper\Drupal\PermissionInfo::class,
      'config_info' => \DrupalCodeGenerator\Helper\Drupal\ConfigInfo::class,
      'processor' => \DrupalCodeGenerator\Helper\Processor\ProcessorInterface::class,
      'dry_dumper' => \DrupalCodeGenerator\Helper\Dumper\DryDumper::class,
      'filesytem_dumper' => \DrupalCodeGenerator\Helper\Dumper\FileSystemDumper::class,
      'renderer' => \DrupalCodeGenerator\Helper\RendererInterface::class,
      'question' => \DrupalCodeGenerator\Helper\QuestionHelper::class,
      'result_printer' => \DrupalCodeGenerator\Helper\ResultPrinter::class,
    ])
  );

PHPStorm docs sidestep the question of what argument the mapping is based on entirely (https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html#passing-a-string-literal), so it's either an undocumented feature or something that used to work previously but doesn't anymore.

Can you please test whether argument offsets work in PHPStorm? If they do, we would just need to default the offset to 0, and if they don't, we would have to drop that additional check and always map on the first argument.

[Chi-teck]

I've just set 0 for the argument. PhpStorm still recognizes the helpers and Psalm is no longer complains about UndefinedInterfaceMethod. In fact, the generator itself sets the offset when generating phpstorm meta.
Thank you.