[Security] remove support for defining voters that don't implement VoterInterface. #23324

hhamon · 2017-06-28T22:20:09Z

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	yes
Deprecations?	no
Tests pass?	yes
Fixed tickets	~
License	MIT
Doc PR	~

xabbuh · 2017-06-29T08:17:18Z

UPGRADE-4.0.md

@@ -455,6 +455,8 @@ Security
 * The `AccessDecisionManager::setVoters()` method has been removed. Pass the
   voters to the constructor instead.

+ * Defining voters that don't implement the `VoterInterface` interface has been removed.


Support for defining [...]

xabbuh · 2017-06-29T08:19:29Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/Compiler/AddSecurityVotersPass.php

-            if (!method_exists($class, 'vote')) {
-                // in case the vote method is completely missing, to prevent exceptions when voting
-                throw new LogicException(sprintf('%s should implement the %s interface when used as voter.', $class, VoterInterface::class));
+                throw new LogicException(sprintf('%s must implement the %s interface when used as voter.', $class, VoterInterface::class));


I would remove the "interface" here (it's already part of the interface name)

[...] used as a voter.

xabbuh · 2017-06-29T08:20:40Z

src/Symfony/Component/Security/CHANGELOG.md

@@ -8,7 +8,8 @@ CHANGELOG
   You should implement this method yourself in your concrete authenticator.
 * removed the `AccessDecisionManager::setVoters()` method
 * removed the `RoleInterface`
- * added a sixth `string $context` argument to`LogoutUrlGenerator::registerListener()`
+ * removed support for voters that don't implement the `VoterInterface` interface


I would remove "interface" here

xabbuh · 2017-06-29T08:22:21Z

src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php

-     *
-     * @deprecated as of 3.4 and will be removed in 4.0. Call the voter directly as the instance will always be a VoterInterface
-     */
-    private function vote($voter, TokenInterface $token, $subject, $attributes)


we could now update the docblock of the constructor so that the type hint for the $voters argument is now VoterInterface[] instead of iterable|VoterInterface[]

Hum I'm not sure! It seems that SecurityBundle passes an iterator argument to the access decision manager so that voters can be lazy loaded.

// AddSecurityVotersPass.php $adm = $container->getDefinition('security.access.decision_manager'); $adm->replaceArgument(0, new IteratorArgument($voters));

We can only change the dockblock but not the signature as passing iterators must still be allowed.

VoterInterface[] means array of VoterInterface instances. So we cannot remove iterable from the phpdoc, otherwise we effectively remove the support of iterators from our supported usage (and so from our BC promise). This is quite problematic when our own usage relies on it.

Hum, I thought VoterInterface[] means something I can iterate over.

hhamon · 2017-06-29T09:32:01Z

Changes applied.

stof · 2017-06-29T09:40:44Z

src/Symfony/Component/Security/CHANGELOG.md

@@ -8,7 +8,8 @@ CHANGELOG
   You should implement this method yourself in your concrete authenticator.
 * removed the `AccessDecisionManager::setVoters()` method
 * removed the `RoleInterface`
- * added a sixth `string $context` argument to`LogoutUrlGenerator::registerListener()`
+ * removed support for voters that don't implement the `VoterInterface`
+ * added a sixth `string $context` argument to`LogoutUrlGenerator::registerListener()` 


please don't add a trailing whitespace in this line

Oups was a mistake.

stof · 2017-06-29T09:41:12Z

src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php

@@ -33,7 +32,7 @@ class AccessDecisionManager implements AccessDecisionManagerInterface
    private $allowIfEqualGrantedDeniedDecisions;

    /**
-     * @param iterable|VoterInterface[] $voters                             An iterator of VoterInterface instances
+     * @param iterable|VoterInterface[] $voters                             An array (or an iterator) of VoterInterface instances


I would not put t in braces

hhamon · 2017-06-29T09:48:02Z

@stof fixed

…e VoterInterface interface.

fabpot · 2017-06-29T21:25:41Z

Thank you @hhamon.

…'t implement VoterInterface. (hhamon) This PR was merged into the 4.0-dev branch. Discussion ---------- [Security] remove support for defining voters that don't implement VoterInterface. | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Commits ------- f527790 [Security] remove support for defining voters that don't implement the VoterInterface interface.

carsonbot added Status: Needs Review Security BC Break labels Jun 28, 2017

hhamon force-pushed the security-voterinterface branch 2 times, most recently from 84f6f5c to 4b91fb5 Compare June 28, 2017 22:32

linaori approved these changes Jun 29, 2017

View reviewed changes

xabbuh reviewed Jun 29, 2017

View reviewed changes

hhamon force-pushed the security-voterinterface branch from 4b91fb5 to 7c400d9 Compare June 29, 2017 09:31

hhamon force-pushed the security-voterinterface branch from 7c400d9 to 1bb6f73 Compare June 29, 2017 09:36

stof requested changes Jun 29, 2017

View reviewed changes

hhamon force-pushed the security-voterinterface branch from 1bb6f73 to 3db09a6 Compare June 29, 2017 09:47

[Security] remove support for defining voters that don't implement th…

f527790

…e VoterInterface interface.

hhamon force-pushed the security-voterinterface branch from 3db09a6 to f527790 Compare June 29, 2017 09:48

stof approved these changes Jun 29, 2017

View reviewed changes

fabpot merged commit f527790 into symfony:master Jun 29, 2017

hhamon deleted the security-voterinterface branch June 30, 2017 07:29

javiereguiluz mentioned this pull request Jul 16, 2017

[Security] remove support for defining voters that don't implement VoterInterface symfony/symfony-docs#8178

Closed

fabpot mentioned this pull request Oct 19, 2017

Release v4.0.0-BETA1 #24612

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Security] remove support for defining voters that don't implement VoterInterface. #23324

[Security] remove support for defining voters that don't implement VoterInterface. #23324

hhamon commented Jun 28, 2017

xabbuh Jun 29, 2017

xabbuh Jun 29, 2017

xabbuh Jun 29, 2017

xabbuh Jun 29, 2017

xabbuh Jun 29, 2017

hhamon Jun 29, 2017

hhamon Jun 29, 2017 •

edited

Loading

hhamon Jun 29, 2017

stof Jun 29, 2017

xabbuh Jun 29, 2017

hhamon commented Jun 29, 2017

stof Jun 29, 2017

hhamon Jun 29, 2017

stof Jun 29, 2017

hhamon commented Jun 29, 2017

fabpot commented Jun 29, 2017

[Security] remove support for defining voters that don't implement VoterInterface. #23324

[Security] remove support for defining voters that don't implement VoterInterface. #23324

Conversation

hhamon commented Jun 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hhamon Jun 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hhamon commented Jun 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hhamon commented Jun 29, 2017

fabpot commented Jun 29, 2017

hhamon Jun 29, 2017 •

edited

Loading