[HttpKernel] Bindings scalar named arguments to action method does not work #24555

yceruto · 2017-10-13T23:14:01Z

Q	A
Bug report?	yes
Feature request?	no
BC Break report?	no
RFC?	no
Symfony version	3.4

I have this controller/action with a scalar argument $env:

public function postShowAction(Post $post, string $env): Response
{
    // do something with $env
}

My configuration to bind this argument:

services:
    _defaults:
        # ...
        bind:
            $env: '%kernel.environment%'

    App\Controller\:
        resource: '../src/Controller'
        tags: ['controller.service_arguments']

> bin/console cache:clear:

Type error: Argument 1 passed to Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument::__construct() must be an instance of Symfony\Component\DependencyInjection\Reference, string given, called in /home/yceruto/github/symfony/symfony-demo/vendor/symfony/dependency-injection/Compiler/ServiceLocatorTagPass.php on line 81

Setting a plain string value ($args[$p->name] = $bindingValue; -> '%kernel.environment%')...

symfony/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php

Lines 137 to 139 in 42390a2

    
           list($bindingValue, $bindingId) = $binding->getValues(); 
        
           $binding->setValues(array($bindingValue, $bindingId, true)); 
        
           $args[$p->name] = $bindingValue;

...that later will be passed to ServiceLocatorTagPass::register() which expects a Reference instance for each arg:

symfony/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php

Lines 160 to 162 in 42390a2

    
           if ($args) { 
        
               $controllers[$id.':'.$r->name] = ServiceLocatorTagPass::register($container, $args); 
        
           }

I don't have idea how it should be solved, so repo/branch to reproduce the bug:

https://github.com/yceruto/symfony-demo/tree/upgrade_to_34

Note: This work fine with constructor arguments (as __constructor method is not included in the previous "pass" but ResolveBindingsPass).

ping @nicolas-grekas, @GuilhemN

The text was updated successfully, but these errors were encountered:

weaverryan · 2017-10-15T13:26:54Z

Hmmm, I know you can specify scalar args if you specify them on the controller.service_arguments tag... so the controller args system does support scalar args. I’m not in a spot to look at the code deeply, but there should be a simple fix: make bind do the same thing that happens with the processing of the args on the tag. Maybe that help... but me (later) or Nicolas may need to check this...

nicolas-grekas · 2017-10-15T19:11:58Z

That's by design: the argument resolver is based on a service locator, and service locators are not compatible with scalar args. Changing this would be considered as a new feature, and would need some discussion because we consciously did not allow so.
The workaround is trivial: just inject the scalar on the constructor. In fact, technically speaking, there is no benefit to injecting scalars to actions, because there is no laziness required here.

yceruto · 2017-10-15T21:09:39Z

That's by design: the argument resolver is based on a service locator, and service locators are not compatible with scalar args.

Then we need an appropriate exception message? otherwise it means to me as an incomplete feature.

The workaround is trivial: just inject the scalar on the constructor. In fact, technically speaking, there is no benefit to injecting scalars to actions, because there is no laziness required here.

Agree, that's what I did, but for DX it should be better IMHO, just:

-public function postShowAction(Post $post): Response
+public function postShowAction(Post $post, string $env): Response
{
    // do something with $env
}

vs

+private $env;

+public function __constructor(string $env)
+{
+    $this->env = $env;
+}

public function postShowAction(Post $post): Response
{
    // do something with $this->env
}

mainly if it's used in a single method (which is the case here).

weaverryan · 2017-10-16T22:23:26Z

Ok, we definitely need a clear error :)

nicolas-grekas · 2017-10-16T22:53:20Z

See #24582

weaverryan · 2017-10-16T23:16:22Z

Actually... this is trickier. We can’t throw an exception, because binding a scalar value is legal in general, and having an argument with the same name as a bound value is also legal. All we can do (I think) is not pass the value to that arg. But, that will be quite unexpected: binding works for the constructor, method calls and most controller args (services, but not scalar). This looks like a wtf to me, and a tough error to spot (why is this arg not being bound). It’s unexpected... and even if it was intentional, it smells like a “bug” (that’s what users will think)

yceruto · 2017-10-17T12:34:57Z

Absolutely agree with @weaverryan.

All we can do (I think) is not pass the value to that arg.

👍

nicolas-grekas · 2017-10-18T00:05:21Z

👍 also

yceruto · 2017-10-18T05:55:22Z

See #24600

@route

… arguments (yceruto) This PR was merged into the 3.4 branch. Discussion ---------- [HttpKernel] Don't bind scalar values to controller method arguments | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#24555 (comment) | License | MIT | Doc PR | - See linked issue. Let's suppose we have this configuration: ```yaml services: _defaults: # ... bind: $foo: '%foobar%' ``` `$foo` was successfully bound to any controller constructor, but in another controller I have this edit action (nothing to do with the intention of bind such a parameter, but it has the same name): ```php /** * @route("/{foo}/edit") */ public function editAction(string $foo) {} ``` triggering: > Type error: Argument 1 passed to Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument::__construct() must be an instance of Symfony\Component\DependencyInjection\Reference, string given, called in /home/yceruto/github/symfony/symfony-demo/vendor/symfony/dependency-injection/Compiler/ServiceLocatorTagPass.php on line 81 or after symfony/symfony#24582: > Invalid service locator definition: only services can be referenced, "string" found for key "foo". Inject parameter values using constructors instead. Commits ------- a1df9af don't bind scalar values to controller method arguments

@route

… arguments (yceruto) This PR was merged into the 3.4 branch. Discussion ---------- [HttpKernel] Don't bind scalar values to controller method arguments | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #24555 (comment) | License | MIT | Doc PR | - See linked issue. Let's suppose we have this configuration: ```yaml services: _defaults: # ... bind: $foo: '%foobar%' ``` `$foo` was successfully bound to any controller constructor, but in another controller I have this edit action (nothing to do with the intention of bind such a parameter, but it has the same name): ```php /** * @route("/{foo}/edit") */ public function editAction(string $foo) {} ``` triggering: > Type error: Argument 1 passed to Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument::__construct() must be an instance of Symfony\Component\DependencyInjection\Reference, string given, called in /home/yceruto/github/symfony/symfony-demo/vendor/symfony/dependency-injection/Compiler/ServiceLocatorTagPass.php on line 81 or after #24582: > Invalid service locator definition: only services can be referenced, "string" found for key "foo". Inject parameter values using constructors instead. Commits ------- a1df9af don't bind scalar values to controller method arguments

This PR was merged into the 3.3 branch. Discussion ---------- [DI] Enhance service locator error message | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #24555 | License | MIT | Doc PR | - See linked issue. Commits ------- fdb0ea9 [DI] Enhance service locator error message

…ers (weaverryan) This PR was merged into the 3.3 branch. Discussion ---------- Adding warning about non-service arguments for controllers Hi guys! See: symfony/symfony#24555 (comment) This is for 3.3. In 3.4 we can improve this further: by updating the example of this to use `bind` (which is much nicer than the ugly tag) and probably show an example of using `bind` along with a scalar argument to the constructor. In other words, 3.4 is a todo once this is merged. Thanks! Commits ------- 72a0685 Adding warning about non-service arguments

chalasr added Bug HttpKernel labels Oct 14, 2017

carsonbot added the Status: Needs Review label Oct 14, 2017

nicolas-grekas mentioned this issue Oct 16, 2017

[DI] Enhance service locator error message #24582

Merged

nicolas-grekas added this to the 3.4 milestone Oct 18, 2017

yceruto mentioned this issue Oct 18, 2017

[HttpKernel] Don't bind scalar values to controller method arguments #24600

Merged

nicolas-grekas closed this as completed Oct 20, 2017

weaverryan mentioned this issue Oct 29, 2017

Adding warning about non-service arguments for controllers symfony/symfony-docs#8558

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[HttpKernel] Bindings scalar named arguments to action method does not work #24555

[HttpKernel] Bindings scalar named arguments to action method does not work #24555

yceruto commented Oct 13, 2017 •

edited

Loading

weaverryan commented Oct 15, 2017

Uh oh!

nicolas-grekas commented Oct 15, 2017

Uh oh!

yceruto commented Oct 15, 2017 •

edited

Loading

Uh oh!

weaverryan commented Oct 16, 2017

Uh oh!

nicolas-grekas commented Oct 16, 2017

Uh oh!

weaverryan commented Oct 16, 2017

Uh oh!

yceruto commented Oct 17, 2017 •

edited

Loading

Uh oh!

nicolas-grekas commented Oct 18, 2017

Uh oh!

yceruto commented Oct 18, 2017

Uh oh!

Uh oh!

[HttpKernel] Bindings scalar named arguments to action method does not work #24555

[HttpKernel] Bindings scalar named arguments to action method does not work #24555

Comments

yceruto commented Oct 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

weaverryan commented Oct 15, 2017

Uh oh!

nicolas-grekas commented Oct 15, 2017

Uh oh!

yceruto commented Oct 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weaverryan commented Oct 16, 2017

Uh oh!

nicolas-grekas commented Oct 16, 2017

Uh oh!

weaverryan commented Oct 16, 2017

Uh oh!

yceruto commented Oct 17, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Oct 18, 2017

Uh oh!

yceruto commented Oct 18, 2017

Uh oh!

yceruto commented Oct 13, 2017 •

edited

Loading

yceruto commented Oct 15, 2017 •

edited

Loading

yceruto commented Oct 17, 2017 •

edited

Loading