Skip to content

Commit

Permalink
Autowire container params
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiu-cristea committed Nov 3, 2024
1 parent 038a783 commit 2dcccbd
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 23 deletions.
65 changes: 56 additions & 9 deletions src/Commands/AutowireTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace Drush\Commands;

use Drupal\Component\DependencyInjection\ContainerInterface as DrupalContainer;
use Drush\Drush;
use League\Container\Container as DrushContainer;
use Psr\Container\ContainerInterface;
use Symfony\Component\DependencyInjection\Attribute\Autowire;
use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
Expand All @@ -16,31 +19,75 @@
*/
trait AutowireTrait
{
/**
/**
* Limit to service and param or plain value.
*
* @see \Symfony\Component\DependencyInjection\Attribute\Autowire::__construct
*/
private const ACCEPTED_AUTOWIRE_ARGUMENTS = [
0 => 'value',
1 => 'service',
4 => 'param',
];

/**
* Instantiates a new instance of the implementing class using autowiring.
*
* @param ContainerInterface $container
* The service container this instance should use.
*
* @return static
*/
public static function create(ContainerInterface $container)
public static function create(ContainerInterface $container, ?ContainerInterface $drushContainer = null): self
{
$args = [];

if (method_exists(static::class, '__construct')) {
$drushContainer = $container instanceof DrushContainer ? $container : ($drushContainer instanceof DrushContainer ? $drushContainer : Drush::getContainer());
$drupalContainer = $container instanceof DrupalContainer ? $container : null;

$constructor = new \ReflectionMethod(static::class, '__construct');
foreach ($constructor->getParameters() as $parameter) {
$service = ltrim((string) $parameter->getType(), '?');
foreach ($parameter->getAttributes(Autowire::class) as $attribute) {
$service = (string) $attribute->newInstance()->value;
if (!$attributes = $parameter->getAttributes(Autowire::class)) {
// No #[Autowire()] attribute.
$service = ltrim((string) $parameter->getType(), '?');
if (!$drushContainer->has($service)) {
throw new AutowiringFailedException($service, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s::_construct()", you should configure its value explicitly.', $service, $parameter->getName(), static::class));
}
$args[] = $drushContainer->get($service);
continue;
}

if (!$container->has($service)) {
throw new AutowiringFailedException($service, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s::_construct()", you should configure its value explicitly.', $service, $parameter->getName(), static::class));
}
// This parameter has an #[Autowire()] attribute.
[$attribute] = $attributes;
$value = null;
foreach ($attribute->getArguments() as $key => $argument) {
// Resolve argument name when arguments are passed as list.
if (is_int($key)) {
if ($argument === null || !isset(self::ACCEPTED_AUTOWIRE_ARGUMENTS[$key])) {
continue;
}
$key = self::ACCEPTED_AUTOWIRE_ARGUMENTS[$key];
}

if (!in_array($key, self::ACCEPTED_AUTOWIRE_ARGUMENTS, true)) {
continue;
}

$args[] = $container->get($service);
$value = $attribute->newInstance()->value;
$valueAsString = (string) $value;
$value = match ($key) {
'service' => $drushContainer->has($valueAsString) ? $drushContainer->get($valueAsString) : throw new AutowiringFailedException($valueAsString, sprintf('Cannot autowire service "%s": argument "$%s" of method "%s::_construct()", you should configure its value explicitly.', $valueAsString, $parameter->getName(), static::class)),
// Container param comes as %foo.bar.param%.
'param' => $drupalContainer ? $drupalContainer->getParameter(trim($valueAsString, '%')) : $valueAsString,
default => $value,
};
// Done as Autowire::__construct() only needs one argument.
break;
}
if ($value !== null) {
$args[] = $value;
}
}
}

Expand Down
3 changes: 2 additions & 1 deletion src/Commands/generate/GenerateCommands.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use Drush\Commands\core\DocsCommands;
use Drush\Commands\DrushCommands;
use Drush\Commands\help\ListCommands;
use Psr\Container\ContainerInterface as DrushContainer;
use League\Container\DefinitionContainerInterface as DrushContainer;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Completion\CompletionInput;
use Symfony\Component\Console\Completion\CompletionSuggestions;
Expand All @@ -21,6 +21,7 @@ final class GenerateCommands extends DrushCommands
protected function __construct(
private readonly DrushContainer $drush_container,
) {
parent::__construct();
}

public static function create(DrushContainer $container): self
Expand Down
64 changes: 51 additions & 13 deletions src/Runtime/ServiceManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
use Grasmash\YamlCli\Command\UnsetKeyCommand;
use Grasmash\YamlCli\Command\UpdateKeyCommand;
use Grasmash\YamlCli\Command\UpdateValueCommand;
use League\Container\Container as DrushContainer;
use League\Container\Container;
use League\Container\DefinitionContainerInterface as DrushContainer;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Robo\ClassDiscovery\RelativeNamespaceDiscovery;
Expand Down Expand Up @@ -342,18 +344,16 @@ public function instantiateServices(array $bootstrapCommandClasses, DrushContain

// Prevent duplicate calls to delegate() by checking for state.
if ($container && !$drushContainer->has('state')) {
assert($drushContainer instanceof Container);
// Combine the two containers.
$drushContainer->delegate($container);
}
foreach ($bootstrapCommandClasses as $class) {
$commandHandler = null;

try {
if ($this->hasStaticCreateFactory($class) && $this->supportsCompoundContainer($class, $drushContainer)) {
// Hurray, this class is compatible with the container with delegate.
$commandHandler = $class::create($drushContainer);
} elseif ($container && $this->hasStaticCreateFactory($class)) {
$commandHandler = $class::create($container, $drushContainer);
if ($staticCreateFactoryArguments = $this->getStaticCreateFactoryArguments($class, $drushContainer, $container)) {
$commandHandler = $class::create(...$staticCreateFactoryArguments);
} elseif (!$container && $this->hasStaticCreateEarlyFactory($class)) {
$commandHandler = $class::createEarly($drushContainer);
} else {
Expand All @@ -372,22 +372,60 @@ public function instantiateServices(array $bootstrapCommandClasses, DrushContain
return $commandHandlers;
}

/**
* Determine if the first parameter of the create method supports our container with delegate.
*/
protected function supportsCompoundContainer($class, $drush_container): bool
protected function getStaticCreateFactoryArguments(string $class, DrushContainer $drushContainer, ?DrupalContainer $drupalContainer = null): ?array
{
if (!method_exists($class, 'create')) {
return null;
}

$reflection = new \ReflectionMethod($class, 'create');
$hint = (string)$reflection->getParameters()[0]->getType();
return is_a($drush_container, $hint);
if (!$reflection->isStatic()) {
return null;
}

$params = $reflection->getParameters();

$args = [];
$type = ltrim((string) $params[0]->getType(), '?');
if ($drupalContainer && is_a($type, DrupalContainer::class, true)) {
// The factory create() method explicitly expects a Drupal container as 1st argument.
$args[] = $drupalContainer;
} elseif (is_a($type, DrushContainer::class, true)) {
// The factory create() method explicitly expects a Drush container as 1st argument. Don't add a 2nd
// argument. If the Drupal container has been initialized, it's already a delegate.
return [$drushContainer];
} elseif ($drupalContainer && is_a($type, ContainerInterface::class, true)) {
// The factory create() method expects a container of any type as st argument and the Drupal container has
// been initialized. Pass it as 1st argument.
$args[] = $drupalContainer;
}

// Add Drush container as 2nd argument if the method expects one.
if (isset($params[1])) {
$type = ltrim((string) $params[1]->getType(), '?');
if (is_a($type, ContainerInterface::class, true)) {
$args[] = $drushContainer;
}
}

return $args;
}

/**
* Check to see if the provided class has a static `create` method.
*/
protected function hasStaticCreateFactory(string $class): bool
{
return static::hasStaticMethod($class, 'create');
if (!$hasStaticCreateFactory = static::hasStaticMethod($class, 'create')) {
return false;
}
$reflection = new \ReflectionMethod($class, 'create');
// Check first two param typings.
foreach (array_slice($reflection->getParameters(), 0, 2) as $param) {
$typing = ltrim((string) $param->getType(), '?');
$hasStaticCreateFactory = $hasStaticCreateFactory && is_a($typing, ContainerInterface::class, true);
}
return $hasStaticCreateFactory;
}

/**
Expand Down

0 comments on commit 2dcccbd

Please sign in to comment.