[UPDATE] Add UnanimousStrategy

symfony · Neirda24 · Jul 28, 2023 · Jul 30, 2023 · Sep 7, 2023 · Sep 7, 2023
commit 416e91dfa91cf5f29b50bdd8dd24d601b926c69c
diff --git a/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/Configuration.php
@@ -33,7 +33,7 @@
  */
 final class Configuration implements ConfigurationInterface
 {
-    private const KNOWN_STRATEGY_TYPES = ['grant', 'deny', 'not', 'date', 'env', 'request_header', 'request_query', 'request_attribute', 'priority', 'affirmative'];
+    private const KNOWN_STRATEGY_TYPES = ['grant', 'deny', 'not', 'date', 'env', 'request_header', 'request_query', 'request_attribute', 'priority', 'affirmative', 'unanimous'];
 
     public function getConfigTreeBuilder(): TreeBuilder
     {
@@ -70,7 +70,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                                     'date' => ['from' => null, 'until' => null, 'includeFrom' => false, 'includeUntil' => false],
                                     'not' => ['strategy' => null],
                                     'env', 'request_header', 'request_query', 'request_attribute' => ['name' => null],
-                                    'priority', 'affirmative' => ['strategies' => null],
+                                    'priority', 'affirmative', 'unanimous' => ['strategies' => null],
                                     default => [],
                                 };
 
@@ -115,7 +115,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                                             throw new \InvalidArgumentException('"name" must be provided.');
                                         }
                                     },
-                                    'priority', 'affirmative' => static function (array $with): void {
+                                    'priority', 'affirmative', 'unanimous' => static function (array $with): void {
                                         if ([] === (array) $with['strategies']) {
                                             throw new \InvalidArgumentException('"strategies" must be provided.');
                                         }

diff --git a/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/FeatureToggleExtension.php b/src/Symfony/Bundle/FeatureToggleBundle/DependencyInjection/FeatureToggleExtension.php
@@ -115,7 +115,7 @@ private function generateStrategy(string $type, array $with): Definition
             'request_header' => $definition->setArguments(['$headerName' => $with['name']]),
             'request_query' => $definition->setArguments(['$queryParameterName' => $with['name']]),
             'request_attribute' => $definition->setArguments(['$attributeName' => $with['name']]), // Check if RequestStack class exists
-            'priority', 'affirmative' => $definition->setArguments([
+            'priority', 'affirmative', 'unanimous' => $definition->setArguments([
                 '$strategies' => array_map(
                     static fn (string $referencedStrategyName): Reference => new Reference($referencedStrategyName), // @phpstan-ignore-line
                     (array) $with['strategies'],

diff --git a/src/Symfony/Bundle/FeatureToggleBundle/Resources/config/strategies.php b/src/Symfony/Bundle/FeatureToggleBundle/Resources/config/strategies.php
@@ -11,6 +11,7 @@
 use Symfony\Component\FeatureToggle\Strategy\GrantStrategy;
 use Symfony\Component\FeatureToggle\Strategy\NotStrategy;
 use Symfony\Component\FeatureToggle\Strategy\PriorityStrategy;
+use Symfony\Component\FeatureToggle\Strategy\UnanimousStrategy;
 
 return static function (ContainerConfigurator $container) {
     $prefix = 'feature_toggle.abstract_strategy.';
@@ -45,4 +46,7 @@
     $services->set($prefix.'affirmative', AffirmativeStrategy::class)->abstract()->args([
         '$strategies' => abstract_arg('Defined in FeatureToggleExtension'),
     ]);
+    $services->set($prefix.'unanimous', UnanimousStrategy::class)->abstract()->args([
+        '$strategies' => abstract_arg('Defined in FeatureToggleExtension'),
+    ]);
 };
diff --git a/...mfony/Bundle/FeatureToggleBundle/Tests/DependencyInjection/FeatureToggleExtensionTest.php b/...mfony/Bundle/FeatureToggleBundle/Tests/DependencyInjection/FeatureToggleExtensionTest.php
@@ -71,6 +71,11 @@ public function getConfig(): array
                         'type' => 'affirmative',
                         'with' => ['strategies' => ['env.feature-strategy', 'grant.feature-strategy']],
                     ],
+                    [
+                        'name' => 'unanimous.feature-strategy',
+                        'type' => 'unanimous',
+                        'with' => ['strategies' => ['env.feature-strategy', 'grant.feature-strategy']],
+                    ],
                     [
                         'name' => 'not.feature-strategy',
                         'type' => 'not',

diff --git a/src/Symfony/Component/FeatureToggle/Strategy/UnanimousStrategy.php b/src/Symfony/Component/FeatureToggle/Strategy/UnanimousStrategy.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\FeatureToggle\Strategy;
+
+use Symfony\Component\FeatureToggle\StrategyResult;
+
+final class UnanimousStrategy implements StrategyInterface
+{
+    /**
+     * @param iterable<StrategyInterface> $strategies
+     */
+    public function __construct(
+        private readonly iterable $strategies,
+    ) {
+    }
+
+    public function compute(): StrategyResult
+    {
+        $result = StrategyResult::Abstain;
+        foreach ($this->strategies as $strategy) {
+            $innerResult = $strategy->compute();
+
+            if (StrategyResult::Deny === $innerResult) {
+                return StrategyResult::Deny;
+            }
+
+            if (StrategyResult::Grant === $innerResult) {
+                $result = StrategyResult::Grant;
+            }
+        }
+
+        return $result;
+    }
+}
diff --git a/src/Symfony/Component/FeatureToggle/Tests/Strategy/AffirmativeStrategyTest.php b/src/Symfony/Component/FeatureToggle/Tests/Strategy/AffirmativeStrategyTest.php
@@ -14,7 +14,6 @@
 use Symfony\Component\FeatureToggle\Strategy\AffirmativeStrategy;
 use Symfony\Component\FeatureToggle\Strategy\StrategyInterface;
 use Symfony\Component\FeatureToggle\StrategyResult;
-use function is_a;
 
 /**
  * @covers \Symfony\Component\FeatureToggle\Strategy\AffirmativeStrategy

diff --git a/src/Symfony/Component/FeatureToggle/Tests/Strategy/UnanimousStrategyTest.php b/src/Symfony/Component/FeatureToggle/Tests/Strategy/UnanimousStrategyTest.php
@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\FeatureToggle\Tests\Strategy;
+
+use Symfony\Component\FeatureToggle\Strategy\AffirmativeStrategy;
+use Symfony\Component\FeatureToggle\Strategy\StrategyInterface;
+use Symfony\Component\FeatureToggle\Strategy\UnanimousStrategy;
+use Symfony\Component\FeatureToggle\StrategyResult;
+
+/**
+ * @covers \Symfony\Component\FeatureToggle\Strategy\AffirmativeStrategy
+ */
+final class UnanimousStrategyTest extends AbstractOuterStrategiesTestCase
+{
+    public static function generatesValidStrategies(): \Generator
+    {
+        yield 'no strategies' => [
+            [],
+            StrategyResult::Abstain,
+        ];
+
+        yield 'if all abstain' => [
+            [
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Abstain),
+            ],
+            StrategyResult::Abstain,
+        ];
+
+        yield 'if one denies after only abstain results' => [
+            [
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Deny),
+            ],
+            StrategyResult::Deny,
+        ];
+
+        yield 'if one grants after only abstain results' => [
+            [
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Grant),
+            ],
+            StrategyResult::Grant,
+        ];
+
+        yield 'if one grants after at least one Deny' => [
+            [
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Deny),
+                self::generateStrategy(StrategyResult::Grant),
+            ],
+            StrategyResult::Deny,
+        ];
+
+        yield 'if one denies after at least one grant' => [
+            [
+                self::generateStrategy(StrategyResult::Abstain),
+                self::generateStrategy(StrategyResult::Grant),
+                self::generateStrategy(StrategyResult::Deny),
+            ],
+            StrategyResult::Deny,
+        ];
+    }
+
+    /**
+     * @dataProvider generatesValidStrategies
+     *
+     * @param iterable<StrategyInterface> $strategies
+     */
+    public function testItComputesCorrectly(iterable $strategies, StrategyResult $expected): void
+    {
+        $affirmativeStrategy = new UnanimousStrategy($strategies);
+
+        self::assertSame($expected, $affirmativeStrategy->compute());
+    }
+}