abrouter/abrouter-php-client

AbrPHPClient :construction_worker_woman: is a PHP library to run ab-tests via ABRouter.

0.22.0 2022-09-04 23:15 UTC

README

AbrPHPClient 👷‍♀️ is a PHP library to run ab-tests via ABRouter. Please, check out ABRouter main repository: https://github.com/abrouter/abrouter

You're welcome to visit the docs.

What is the ABRouter service ?

ABRouter is the service to manage experiments(ab-tests). The service provides easy to manage dashboard to get experiments under control. There you can create experiments, branches and set a percentage for every branch. Then, when you're running an ab-test on PHP you will receive a perfect branch-wise response that following the rules, that you set up.

Can be also used as a feature flag or feature toggle and open-source. Available for free.

📦 Install

Via composer

$ composer require abrouter/abrouter-php-client

🚀 Usage

Client is uses PHP-DI for DI. If you're uses own DI, you must to configure it in a such way as on example below. If you're not uses any DI, let's move php-di from dev-dependency to dependency:

$ composer require "php-di/php-di": "^6.0"

Using with PHP-DI

use Abrouter\Client\Config\Config;
use DI\ContainerBuilder;
use Abrouter\Client\Client;

require '/app/vendor/autoload.php';

$containerBuilder = new ContainerBuilder();
$di = $containerBuilder->build();

$token = '04890788ba2c89c4ff21668c60838a00a87b1cf42c9c6b45d6aa8e11174f0d5762b16b6c09b6b822'; //you can find your token in ABRouter dashboard

$di->set(Config::class, new Config($token, 'https://abrouter.com'));
/**
 * @var Client $client
 */
$client = $di->make(Abrouter\Client\Client::class);
$userSignature = $_SERSSION['userId'] ?? uniqid();
$experimentId = 'button_color';//experiment id is also there


$runExperimentResult = $client->experiments()->run($userSignature, $experimentId);
$experimentId = $runExperimentResult->getExperimentId(); //form-color
$branchId = $runExperimentResult->getBranchId(); //red
echo '<button style="color: '. $branchId .'">Hello</button>';

You can create an experiment and get your token and id of experiment on ABRouter or just read the docs.

Sending the stats

use Abrouter\Client\Config\Config;
use DI\ContainerBuilder;
use Abrouter\Client\Client;
use Abrouter\Client\Builders\StatEventBuilder;

require '/app/vendor/autoload.php';

$userSignature = $_SERSSION['userId'] ?? uniqid();

$containerBuilder = new ContainerBuilder();
$di = $containerBuilder->build();

/**
 * @var Client $client
 */
$client = $di->make(Abrouter\Client\Client::class); // using PHP-DI

$eventBuilder = $this->getContainer()->make(StatEventBuilder::class);

//sending button_click event as button_click+1
$client->statistics()->sendEvent(
    $eventBuilder
        ->incremental()
        ->event('button_click')
        ->setUserId($userSignature)
        ->build()
);

// sending purchase event with purchase amount
$client->statistics()->sendEvent(
    $eventBuilder
        ->summarize()
        ->event('purchase')
        ->setValue(30)
        ->setUserId($userSignature)
        ->build()
);

For additional details of sending events please see StatEventBuilder class.

Parallel running

Parallel running is a mode which allows you to run the experiments asynchronous. Main things to make it works are configuring KvStorage and TaskManager. KvStorage and TaskManager are using Redis to store data and tasks.

ABRouter php client has built-in KvStorage and TaskManager, but you can make your own implementation and replace it via DI and contracts. We're highly recommend you to use built-in solution. The implementation is completely tested and works well. Using Parallel running gives you a great growth in speed.

The config for parallel running is a bit different from the default config.

Configuration

use Abrouter\Client\Config\Config;
use DI\ContainerBuilder;
use Abrouter\Client\Client;
use Abrouter\Client\Config\RedisConfig;
use Abrouter\Client\Contracts\KvStorageContract;
use Abrouter\Client\DB\RedisConnection;
use Abrouter\Client\Services\KvStorage\KvStorage;
use Abrouter\Client\Services\TaskManager\TaskManager;
        
require '/app/vendor/autoload.php';
        
$containerBuilder = new ContainerBuilder();
$di = $containerBuilder->build();


$redisConfig = new RedisConfig(
    $_SERVER['REDIS_HOST'] ?? 'redis',
    6379,
    '',
    '',
    ''
);

$host = 'https://abrouter.com';
$token = uniqid();

$config = new Config(
    $token,
    $host,
);
$config->setRedisConfig($redisConfig);
$container->set(Config::class, $config);

$kvStorage = $container->make(KvStorage::class);
$container->make(KvStorage::class);
$container->set(
    KvStorageContract::class,
    $kvStorage
);

$config->setKvStorageConfig($kvStorage);
$container->set(Config::class, $config);
$taskManager = $container->make(TaskManager::class);

$config->setParallelRunConfig(new ParallelRunConfig(true, $taskManager));

Worker

Worker is a supervisor config which running the process which handles your tasks. Make sure supervisor is installed on your machine. The example of supervisor config is located in worker/worker.conf. Please, configure the worker.php before running the supervisor config. You have to put the same configuration of the client there as in your main application. Copy supervisor config to the specific folder which specified in etc/init.d/supervisord.conf. And, please don't forget to adjust the path of worker.php aligned to your application base directory.

✅ Testing

Requires docker-compose and docker installed.

$ make up
$ make test-run

🔧 Contributing

Please feel free to fork and sending Pull Requests. This project follows Semantic Versioning 2 and PSR-2.

📄 License

GPL3. Please see License File for more information.