landingi/toggle-bundle

Bundle with core functionality that gives a hand to check features for a given account

v1.0.0 2021-04-01 12:00 UTC

Requires

• php: >=7.4
• doctrine/dbal: ^2.12
• predis/predis: ^1.1
• symfony/framework-bundle: ^5.2
• symfony/uid: ^5.2

Requires (Dev)

• landingi/crap-metric-analyzer: ^1.0
• landingi/php-coding-standards: ^1.0
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest

MIT

• Miłosz Lenczewski

README

Toggle bundle

Feature Flag

System for checking whether account has feature flag enabled.

FeatureFlagsSource

implementations:

• Landingi\ToggleBundle\FeatureFlagsSource\DbSource - should use Landingi Read Only DB instance to fetch features from accounts_features table by account's UUID and from packages_features table by account's package.

• Landingi\ToggleBundle\FeatureFlagsSource\RedisSource - fetches feature flags list cached in Redis by account's UUID as a key.

• Landingi\ToggleBundle\FeatureFlagsSource\CachingSource - this class is an abstraction for caching feature flags list for account.

Configuration

The bundle provides a configuration that allows you to easily control the data access layer. Configuration file should be created at a path: config/packages/landingi_toggle.yaml.

landingi_toggle:
    dbal:
        connection_name: mysql # DBAL connection name (this should be a read only connection, for a better performance)
    cache:
        enabled: true # If enabled then CachingSource is used, otherwise DbSource is used to fetch the feature flags
        redis_connection:
            schema: 'tcp'
            host: '%env(REDIS_HOST)%'
            port: 6379
        ttl: 60 # Time to live for cached feature flags entries for a selected account_uuid

Usage

To check feature flag access for a selected account_uuid follow below code snippet:

use Landingi\ToggleBundle\AccessVoter;

class ExampleService
{
    private AccessVoter $accessVoter;
 
    public function __construct(AccessVoter $accessVoter)
    {
        $this->accessVoter = $accessVoter;
    }
    
    public function exampleMethod(string $accountUuid)
    {
        /** ... some logic  */
        
        if ($this->accessVoter->vote($accountUuid, 'EXAMPLE_FEATURE_FLAG')) {
            // Access granted
        }
    }
}

AccessVoter is already defined in the symfony dependency injection container, so we can easily use it as a dependency in every service class in the whole project.