ABRouter AB Test π·ββοΈ is a simple package for base library to run A/B tests via ABRouter (open-source) with Laravel. You can find base PHP library in https://github.com/abrouter/abrouter-php-client
You're welcome to visit the docs.
Learn how to deploy ABRouter on your server.
ABRouter is the open-source product to manage experiments(A/B split tests). The service provides easy to manage dashboard to keep experiments under control. You can create experiments, branches and set up 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.
Providing feature flags(feature toggles) Available for free and open-source.
You can find the ABRouter product source code by the following link: https://github.com/abrouter/compose
π A/B Tests
π Feature flags
π Built-in statistics
π Incredible UI to manage it
π Parallel running (non-blocking A/B tests running)
Besides of the installing this package you need to have an account on ABRouter. Your token and experiment id will be also there. Feel free to read step by step instruction Impelementing A/B tests on Laravel
Via composer
$ composer require abrouter/laravel-abtest
This package provide auto discovery for service provider
If Laravel package auto-discovery is disabled, add service providers manually to /config/app.php. There are service provider you must add:
\Abrouter\LaravelClient\Providers\AbrouterServiceProvider::class
php artisan vendor:publish --tag=abrouter
Put your ABRouter token in /config/abrouter.php. You can find this token in ABRouter dashboard.
use Abrouter\LaravelClient\Bridge\KvStorage;
use Abrouter\LaravelClient\Bridge\ParallelRunning\TaskManager;
return [
'token' => '14da89de1713a74c1ed50aafaff18c24bf372a9913e67e6a7a915def3332a97c9c9ecbe2cd6d3047',
'host' => 'https://abrouter.com',
'parallelRunning' => [
'enabled' => true, //parallel running, enabled by default. See next section.
'taskManager' => TaskManager::class,
],
'kvStorage' => KvStorage::class
];
Parallel running is a feature that allows you to run A/B tests asynchronously. It requires ready-to-use Laravel cache (probably by Redis).
This feature enables caching of experiment branches to run the experiment locally, then using Laravel built-in queues to sync the data with ABRouter server. Please make sure, your supervisor config, queues and caching storage is enabled in Laravel to use.
Parallel running allows to run your A/B tests without blocking. Additionally, you can configure it on your own.
use Abrouter\Client\Client;
class ExampleController
{
public function __invoke(Client $client)
{
$userId = auth()->user()->id;
$buttonColor = $client->experiments()->run($userId, 'button_color');
return view('button', [
'color' => $buttonColor->getBranchId(),
]);
}
}
use Abrouter\Client\Client;
class ExampleController
{
public function __invoke(Client $client)
{
$isEnabledButton = $client->featureFlags()->run('enabled_button_feature_flag');
return view('featureFlags', [
'enabledButtonFeatureFlag' => $isEnabledButton,
]);
}
}
use Abrouter\Client\Client;
use Abrouter\Client\Builders\StatEventBuilder;
class ExampleController
{
public function __invoke(Client $client, StatEventBuilder $statEventBuilder)
{
$userId = auth()->user()->id;
//sending button_click event as button_click+1
$client->statistics()->sendEvent(
$eventBuilder
->incremental()
->event('button_click')
->setUserId($userId)
->build()
);
//sending purchase event with purchase amount (+30)
$client->statistics()->sendEvent(
$eventBuilder
->summarize()
->event('purchase')
->setValue(30)
->setUserId($userId)
->build()
);
}
}
For additional details of sending events please see StatEventBuilder class.
You can create an experiment/feature flags and set up statistics and get your token and id of experiment on ABRouter or just read the docs.
You can get an dockerized usage example by the following link: (https://github.com/abrouter/laravel-example)
Please feel free to fork and sending Pull Requests. This project follows Semantic Versioning 2 and PSR-2.
GPL3. Please see License File for more information.