README

Symfony bundle integration with CloudBees Feature Flags (Rox by Rollout) php sdk.

Installation

Install with composer at krak/symfony-rollout-rox.

If symfony's composer install doesn't automatically register the bundle, you can do so manually:

<?php

return [
  //...
  Krak\SymfonyRox\RoxBundle::class => ['all' => true],
];

Usage

Configuring the App Environment Key

Via ENV

Set the ROLLOUT_ROX_APP_ENV_KEY environment variable, and the system will pick up that key for configuration.

Via Parameter

The app environment key is set in the symfony parameter rollout_rox_app_env_key. You can set that parameter directly in your app parameters config like:

parameters:
  rollout_rox_app_env_key: 'key goes here'

Registering Containers

The Rox php library works by registering container objects with public properties that contain the default flags/variants for an experiment. The Rox system will automatically register your flags/variants with the rollout api/admin interface.

To create and register a container, you can implement the RoxContainer interface.

<?php

namespace App\FeatureFlags;

use Krak\SymfonyRox\RoxContainer;
use Rox\Server\Flags\RoxFlag;

final class ProductContainer implements RoxContainer
{
    public $showQtyOnPDP;

    public function __construct() {
        $this->showQtyOnPDP = new RoxFlag(false);
    }
    
    // the namespace controls the prefix used in the rollout admin
    // when displaying your flags or variants. Every container MUST have a unique 
    // namespace.
    public function getNamespace(): string {
        return 'product';
    }
}

Then to use that container in a service, you'll need to access it via the ContainerStore.

<?php

namespace App\Service;

use Krak\SymfonyRox\RoxContainerStore;

final class BuildPDPPrices
{
    private $flagsStore;

    public function __construct(RoxContainerStore $flagsStore) {
        $this->flagsStore = $flagsStore;
    }

    public function __invoke(string $productId): array {
        $container = $this->flagsStore->get(\App\FeatureFlags\ProductContainer::class);
        return [
            'qty' => $container->showQtyOnPDP->isEnabled() ? 1 : null,
            'price' => 100,
        ];
    }
}

The ContainerStore is needed to lazily initialize the Rox system. Not all requests will need to use a feature flag, so the bundle doesn't initialize until a container is accessed from the store.

Customizing the Rox Setup

Adjusting Rox Options

If you just need to modify the RoxOptions that you would pass into Rox::setup, then you can setup a factory to build the RoxOptions, then add a service definition for those rox options, and then update the RoxSetup service definition arguments to accept the RoxOptions as the second parameter.

Advanced Customization

If you want to have more flexibility on registration and setup, and any other hooks, it's best to just implement your own RoxSetup instance and then register your service for RoxSetup instead of the default, or you could also use decoration as well, whatever works best for you.

You can checkout the GlobalDefaultRoxSetup class to see the simple implementation.

krak / symfony-rollout-rox

Maintainers

Details