Merge pull request #19 from chadha/DEV-RatioVoterWithNullSession

make argument session optional, with on-invalid="null"

Author: elbcoast

Resources/config/services.xml

@@ -32,7 +32,7 @@
 
         <!-- Ratio Voter -->
         <service id="ecn_featuretoggle.voter_ratio" class="Ecn\FeatureToggleBundle\Voters\RatioVoter">
-            <argument type="service" id="session"/>
+            <argument type="service" id="session" on-invalid="null"/>
             <tag name="ecn_featuretoggle.voter" alias="RatioVoter"/>
         </service>
 

Tests/Voters/RatioVoterTest.php

@@ -13,9 +13,11 @@
 namespace Ecn\FeatureToggleBundle\Tests\Voters;
 
 use Ecn\FeatureToggleBundle\Voters\RatioVoter;
+use InvalidArgumentException;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Session\Session;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
 /**
  * @author Pierre Groth <pierre@elbcoast.net>
@@ -32,71 +34,66 @@ public function testLowRatioVoterPass(): void
         $this->assertLessThan(100 - $hits, $hits);
     }
 
-    protected function getRatioVoter($ratio, $sticky = false): RatioVoter
+    public function testStickyRatioVoterPassOnNullSession(): void
     {
-        // Create service stub
-        /** @var Session&MockObject $session */
-        $session = $this->getMockBuilder(Session::class)
-            ->disableOriginalConstructor()
-            ->getMock();
+        $this->expectException(InvalidArgumentException::class);
 
-        $session->method('get')->willReturnCallback([$this, 'getStickyCallback']);
-        $session->method('has')->willReturnCallback([$this, 'hasStickyCallback']);
-
-        $params = ['ratio' => $ratio, 'sticky' => $sticky];
-
-        $voter = new RatioVoter($session);
-        $voter->setFeature('ratiotest');
-        $voter->setParams($params);
-
-        return $voter;
+        $voter = $this->getRatioVoter(0.5, true, false);
+        $voter->pass();
     }
 
     /**
-     * Executes the tests n time returning the number of passes
+     * @dataProvider dataProvider
      *
-     * @param RatioVoter $ratioVoter
-     * @param int $iterationCount
-     *
-     * @return int
+     * @param bool $hasSession
      */
-    private function executeTestIteration(RatioVoter $ratioVoter, $iterationCount = 100): int
+    public function testHighRatioVoterPass(bool $hasSession): void
     {
-        $hits = 0;
-
-        for ($i = 1; $i <= $iterationCount; $i++) {
-            if ($ratioVoter->pass()) {
-                $hits++;
-            }
-        }
-
-        return $hits;
-    }
-
-    public function testHighRatioVoterPass(): void
-    {
-        $voter = $this->getRatioVoter(0.9);
+        $voter = $this->getRatioVoter(0.9, false, $hasSession);
         $hits = $this->executeTestIteration($voter);
 
         $this->assertGreaterThan(100 - $hits, $hits);
     }
 
-    public function testZeroRatioVoterPass(): void
+    /**
+     * @dataProvider dataProvider
+     *
+     * @param bool $hasSession
+     */
+    public function testZeroRatioVoterPass(bool $hasSession): void
     {
-        $voter = $this->getRatioVoter(0);
+        $voter = $this->getRatioVoter(0, false, $hasSession);
         $hits = $this->executeTestIteration($voter);
 
         $this->assertEquals(0, $hits);
     }
 
-    public function testOneRatioVoterPass(): void
+    /**
+     * @dataProvider dataProvider
+     *
+     * @param bool $hasSession
+     */
+    public function testOneRatioVoterPass(bool $hasSession): void
     {
-        $voter = $this->getRatioVoter(1);
+        $voter = $this->getRatioVoter(1, false, $hasSession);
         $hits = $this->executeTestIteration($voter);
 
         $this->assertEquals(100, $hits);
     }
 
+    /**
+     * Simple data provider for $hasSession
+     *
+     * @return array
+     */
+    public function dataProvider(): array
+    {
+        return [
+            [true],
+            [false],
+        ];
+    }
+
     public function testStickyRatioVoterPass(): void
     {
         $voter = $this->getRatioVoter(0.5, true);
@@ -135,4 +132,48 @@ public function getStickyCallback($key)
     {
         return $this->stickyValues[$key] ?? null;
     }
+
+    protected function getRatioVoter($ratio, $sticky = false, $hasSession = true): RatioVoter
+    {
+        $session = null;
+
+        if($hasSession)
+        {
+            // Create service stub
+            /** @var Session&MockObject $session */
+            $session = $this->createMock(SessionInterface::class);
+
+            $session->method('get')->willReturnCallback([$this, 'getStickyCallback']);
+            $session->method('has')->willReturnCallback([$this, 'hasStickyCallback']);
+        }
+
+        $params = ['ratio' => $ratio, 'sticky' => $sticky];
+
+        $voter = new RatioVoter($session);
+        $voter->setFeature('ratiotest');
+        $voter->setParams($params);
+
+        return $voter;
+    }
+
+    /**
+     * Executes the tests n time returning the number of passes
+     *
+     * @param RatioVoter $ratioVoter
+     * @param int $iterationCount
+     *
+     * @return int
+     */
+    private function executeTestIteration(RatioVoter $ratioVoter, $iterationCount = 100): int
+    {
+        $hits = 0;
+
+        for ($i = 1; $i <= $iterationCount; $i++) {
+            if ($ratioVoter->pass()) {
+                $hits++;
+            }
+        }
+
+        return $hits;
+    }
 }

Voters/RatioVoter.php

@@ -12,6 +12,7 @@
 
 namespace Ecn\FeatureToggleBundle\Voters;
 
+use InvalidArgumentException;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
 /**
@@ -37,9 +38,9 @@ class RatioVoter implements VoterInterface
     protected $sticky = false;
 
     /**
-     * @param SessionInterface $session
+     * @param SessionInterface|null $session
      */
-    public function __construct(SessionInterface $session)
+    public function __construct(SessionInterface $session = null)
     {
         $this->session = $session;
     }
@@ -74,7 +75,12 @@ public function pass(): bool
      */
     protected function getStickyRatioPass(): bool
     {
+        if (null === $this->session) {
+            throw new InvalidArgumentException(sprintf('The service "%s" has a dependency on the session', get_class($this)));
+        }
+
         $sessionKey = '_ecn_featuretoggle_'.$this->feature;
+
         if ($this->session->has($sessionKey)) {
             $pass = $this->session->get($sessionKey);
         } else {