InvalidServiceDefinitionsException on array type from the container

[mike-zukowski]

Using latest version 1.2.8 in Symfony 2.8. Consider an example constructor of a service:

public function __construct(array $values) {
…
}

It is autowired as follows:

app.services.service_id:
    class: App\Services\Fqcn
    arguments:
        - `@=parameter('app_config')['abc']`

with a following application configuration:

app_config:
    abc:
        - a
        - b
        - c

The cache:clear commands reports an exception:

Exception thrown in `app/console ca:cl`:
                                                                                                                         
  [Matthias\SymfonyServiceDefinitionValidator\Exception\InvalidServiceDefinitionsException]                              
  Service definition validation errors (1):                                                                              
  - app.services.service_id: Argument of type "object" should have been an array  
                                                                                                                         

Exception trace:
 () at /var/www/html/vendor/matthiasnoback/symfony-service-definition-validator/Compiler/ValidateServiceDefinitionsPass.php:44
 Matthias\SymfonyServiceDefinitionValidator\Compiler\ValidateServiceDefinitionsPass->process() at /var/www/html/vendor/symfony/symfony/src/Symfony/Component/DependencyInjection/Compiler/Compiler.php:102
 Symfony\Component\DependencyInjection\Compiler\Compiler->compile() at /var/www/html/vendor/symfony/symfony/src/Symfony/Component/DependencyInjection/ContainerBuilder.php:587
 Symfony\Component\DependencyInjection\ContainerBuilder->compile() at /var/www/html/app/container/CustomContainerBuilder.php:12
 CustomContainerBuilder->compile() at /var/www/html/app/AppKernel.php:490
 AppKernel->initializeContainer() at /var/www/html/vendor/symfony/symfony/src/Symfony/Component/HttpKernel/Kernel.php:131
 Symfony\Component\HttpKernel\Kernel->boot() at /var/www/html/app/AppKernel.php:275

[mike-zukowski]

The $argument is an instance of Symfony\Component\ExpressionLanguage\Expression. This is the culprit:

    public function validate(\ReflectionParameter $parameter, $argument)
    {
        if ($parameter->isArray()) {
            if ($parameter->allowsNull() && is_null($argument)) {
                return;
            }
            $this->validateArrayArgument($argument); <------------------------ HERE
        } elseif ($parameter->getClass()) {
            $this->validateObjectArgument($parameter->getClass()->getName(), $argument, $parameter->allowsNull());
        }

        // other arguments don't need to be or can't be validated
    }

    private function validateArrayArgument($argument)
    {
        if (!is_array($argument)) {
            throw new TypeHintMismatchException(sprintf(
                'Argument of type "%s" should have been an array',
                gettype($argument)
            ));
        }
    }

[matthiasnoback]

I don't think this library is still useful at this point. The Symfony container nowadays checks a lot of things itself because of autowiring.

[mike-zukowski]

Not in Sf 2.8 :( If you ask me, the library should check if the property is an object if the expression mentions a =service, not =parameter

[matthiasnoback]

I see, well, I thought it would be a nice challenge to fix this issue, so I'll work on that. No guarantees, and tbh 2.8 is way too old to maintain, but you know that ;) Maybe take a look at Rector, it can probably help you migrate to a newer version.

[mike-zukowski]

Well, our app is a humongous monolith based on 2.8, currently impossible to update to v3 because of some dependencies. But it earns money so... :) thank you!

[matthiasnoback]

Fixed by #51, release as v1.2.10. Let me know if this works for you! By the way, if you don't have calculate expression results set to on, it won't actually check for the array type, but at least it won't throw an error either.

[mike-zukowski]

This is most helpful Matthias. I'll let you know.

[mike-zukowski]

Looks awesome. Thanks a million Matthias, great job as always.

[matthiasnoback]

Cool, no problem!