Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class Configuration implements ConfigurationInterface
/**
* @return TreeBuilder
*/
public function getConfigTreeBuilder()
public function getConfigTreeBuilder(): TreeBuilder
{
$treeBuilder = new TreeBuilder('d_zunke_feature_flags');
$rootNode = $treeBuilder->getRootNode();
Expand Down
3 changes: 3 additions & 0 deletions Resources/config/services.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,6 @@ services:
- '@dz.feature_flags.conditions_bag'
tags:
- { name: console.command }

DZunke\FeatureFlagsBundle\Subscriber\FeatureFlagCookieSubscriber:
tags: [ 'kernel.event_subscriber' ]
29 changes: 29 additions & 0 deletions Subscriber/FeatureFlagCookieSubscriber.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace DZunke\FeatureFlagsBundle\Subscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class FeatureFlagCookieSubscriber implements EventSubscriberInterface
{
public static function getSubscribedEvents(): array
{
return [
KernelEvents::RESPONSE => 'onKernelResponse',
];
}

public function onKernelResponse(ResponseEvent $event): void
{
$request = $event->getRequest();

if (!$request->attributes->has('_feature_flag_cookie')) {
return;
}

$cookie = $request->attributes->get('_feature_flag_cookie');
$event->getResponse()->headers->setCookie($cookie);
}
}
97 changes: 97 additions & 0 deletions Tests/Integration/PercentageCookieIntegrationTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?php

namespace Tests\Integration;

use DZunke\FeatureFlagsBundle\Subscriber\FeatureFlagCookieSubscriber;
use DZunke\FeatureFlagsBundle\Toggle\Conditions\Percentage;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;


class PercentageCookieIntegrationTest extends TestCase
{
private RequestStack $requestStack;
private Percentage $percentage;
private FeatureFlagCookieSubscriber $subscriber;

protected function setUp(): void
{
$this->requestStack = new RequestStack();
$this->percentage = new Percentage($this->requestStack);
$this->subscriber = new FeatureFlagCookieSubscriber();
}

public function testItSetsCookieWhenCookieDoesNotExist(): void
{
$request = new Request();
$this->requestStack->push($request);

$config = [
'percentage' => 100,
'cookie' => '_feature_flag_cookie',
'lifetime' => 3600,
];

$result = $this->percentage->validate($config);

self::assertTrue($result);

self::assertTrue($request->attributes->has('_feature_flag_cookie'));

$cookie = $request->attributes->get('_feature_flag_cookie');
self::assertInstanceOf(Cookie::class, $cookie);
self::assertSame('_feature_flag_cookie', $cookie->getName());
self::assertSame('1', $cookie->getValue());

$response = new Response();

$event = new ResponseEvent(
$this->createMock(HttpKernelInterface::class),
$request,
HttpKernelInterface::MAIN_REQUEST,
$response
);

$this->subscriber->onKernelResponse($event);

$cookies = $response->headers->getCookies();
self::assertCount(1, $cookies);
self::assertSame('_feature_flag_cookie', $cookies[0]->getName());
}

public function testItReturnsCookieValueWhenCookieAlreadyExists(): void
{
$request = new Request();
$request->cookies->set('_feature_flag_cookie', '1');
$this->requestStack->push($request);

$config = [
'percentage' => 0,
'cookie' => '_feature_flag_cookie',
];

$result = $this->percentage->validate($config);

self::assertTrue($result);

self::assertFalse($request->attributes->has('_feature_flag_cookie'));

$response = new Response();

$event = new ResponseEvent(
$this->createMock(HttpKernelInterface::class),
$request,
HttpKernelInterface::MAIN_REQUEST,
$response
);

$this->subscriber->onKernelResponse($event);

self::assertCount(0, $response->headers->getCookies());
}
}
46 changes: 26 additions & 20 deletions Tests/Toggle/Conditions/PercentageTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,38 +41,44 @@ public function testItThrowsExceptionWhenPercentageIsNotSet()
$sut = new Percentage($this->requestStackMock);
$sut->validate([], 'nothing');
}

public function testItReturnsTrueWhenCookieIsAlreadySet()
public function testItReturnsTrueWhenCookieIsAlreadySet(): void
{
$parameterBagMock = $this->createMock(ParameterBag::class);
$parameterBagMock->method('has')->willReturn(true);
$parameterBagMock->method('get')->willReturn(1);

$requestMock = $this->createMock(Request::class);
$requestMock->cookies = $parameterBagMock;
$request = new Request(
cookies: [
'percentage' => 1,
]
);

$requestStackMock = $this->createMock(RequestStack::class);
$requestStackMock->method('getMainRequest')->willReturn($requestMock);
$requestStackMock
->method('getMainRequest')
->willReturn($request);

$sut = new Percentage($requestStackMock);
$this->assertTrue($sut->validate([
'percentage' => 798,
]));

$this->assertTrue(
$sut->validate([
'percentage' => 798,
])
);
}

public function testItReturnsBoolWhenCookieIsNotSet()
public function testItReturnsBoolWhenCookieIsNotSet(): void
{
$parameterBagMock = $this->createMock(ParameterBag::class);
$parameterBagMock->method('has')->willReturn(true);

$requestMock = $this->createMock(Request::class);
$requestMock->cookies = $parameterBagMock;
$request = new Request(cookies: []);

$requestStackMock = $this->createMock(RequestStack::class);
$requestStackMock->method('getMainRequest')->willReturn($requestMock);
$requestStackMock
->method('getMainRequest')
->willReturn($request);

$sut = new Percentage($requestStackMock);
self::assertIsBool($sut->validate(['percentage' => 3]));

self::assertIsBool(
$sut->validate([
'percentage' => 3,
])
);
}

public function testToString()
Expand Down
27 changes: 17 additions & 10 deletions Toggle/Conditions/Percentage.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace DZunke\FeatureFlagsBundle\Toggle\Conditions;

use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

Expand All @@ -23,26 +24,32 @@ public function __construct(RequestStack $requestStack)

/**
* @param mixed $config
* @param null $argument
* @param null $argument
* @return bool
* @throws \Exception
*/
public function validate($config, $argument = null)

public function validate($config, $argument = null): bool
{
$config = $this->formatConfig($config);
$request = $this->requestStack->getMainRequest();

if ($this->requestStack->getMainRequest()->cookies->has($config['cookie'])) {
return (bool)$this->requestStack->getMainRequest()->cookies->get($config['cookie']);
if ($request?->cookies->has($config['cookie'])) {
return (bool) $request->cookies->get($config['cookie']);
}

$value = (int)($this->generateRandomNumber() < $config['percentage']);
setcookie(
$config['cookie'],
$value,
time() + $config['lifetime']
$value = (int) ($this->generateRandomNumber() < $config['percentage']);

$request?->attributes->set(
'_feature_flag_cookie',
new Cookie(
$config['cookie'],
(string)$value,
time() + $config['lifetime']
)
);

return (bool)$value;
return (bool) $value;
}

private function formatConfig($config)
Expand Down
16 changes: 8 additions & 8 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
}
],
"require": {
"php": ">=8.1",
"symfony/http-foundation": "^6.1",
"symfony/http-kernel": "^6.1",
"symfony/dependency-injection": "^6.1",
"symfony/config": "^6.1",
"symfony/console": "^6.1",
"symfony/twig-bridge": "^6.1",
"symfony/yaml": "^6.1"
"php": ">=8.1",
"symfony/http-foundation": "^6.4 || ^7.0",
"symfony/http-kernel": "^6.4 || ^7.0",
"symfony/dependency-injection": "^6.4 || ^7.0",
"symfony/config": "^6.4 || ^7.0",
"symfony/console": "^6.4 || ^7.0",
"symfony/twig-bridge": "^6.4 || ^7.0",
"symfony/yaml": "^6.4 || ^7.0"
},
"require-dev": {
"twig/twig": "~2.0|~3.0",
Expand Down