Merge pull request #5 from abrouter/parallel-running

Parallel running

Author: yatsenkolesh

Config/abrouter.php

@@ -1,7 +1,15 @@
 <?php
 declare(strict_types = 1);
 
+use Abrouter\LaravelClient\Bridge\KvStorage;
+use Abrouter\LaravelClient\Bridge\ParallelRunning\TaskManager;
+
 return [
     'token' => '',
     'host' => 'https://abrouter.com',
+    'parallelRunning' => [
+        'enabled' => true,
+        'taskManager' => TaskManager::class,
+    ],
+    'kvStorage' => KvStorage::class
 ];

README.md

@@ -25,6 +25,9 @@ You can find the ABRouter product source code by the following link: https://git
 
 🛠 Incredible UI to manage it 
 
+🛠 Parallel running (non-blocking A/B tests running)
+
+
 ## Prepare your first A/B test
 Besides of the installing this package you need to have an account on [ABRouter](https://abrouter.com). Your token and experiment id will be also there.
 Feel free to read step by step instruction [Impelementing A/B tests on Laravel](https://abrouter.com/en/laravel-ab-tests)
@@ -56,14 +59,33 @@ php artisan vendor:publish --tag=abrouter
 Put your ABRouter token in /config/abrouter.php. You can find this token in [ABRouter dashboard](https://abrouter.com/en/board).
 
 ```php
+
+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
 ];
 ```
 
+### Configure Parallel running
+
+Parallel running is a feature that allows you to run A/B tests asynchronously. 
+It requires ready-to-use Laravel cache (probably by Redis). 
 
-## :rocket: Usage
+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.
+
+## :rocket: Running A/B tests
 
 ```php
 use Abrouter\Client\Client;
@@ -79,8 +101,46 @@ class ExampleController
     }
 }
 ```
+## :rocket: Running feature flags
+
+```php
+use Abrouter\Client\Client;
+
+class ExampleController
+{
+    public function __invoke(Client $client)
+    {
+        $isEnabledButton = $client->featureFlags()->run('enabled_button_feature_flag');
+
+        return view('featureFlags', [
+            'enabledButtonFeatureFlag' => $isEnabledButton,
+        ]);
+    }
+}
+```
+
+## :rocket: Sending the stats
+
+```php
+use Abrouter\Client\Client;
+
+class ExampleController
+{
+    public function __invoke(Client $client)
+    {
+        //ABRouter can store more data. Please learn more in EventDTO arguments.
+        $client->statistics()->sendEvent(new EventDTO(
+            null,
+            $userId,
+            'visited_test_page'
+        ));
+    }
+}
+```
+
+### Managing UI
 
-You can create an experiment and get your token and id of experiment on [ABRouter](https://abrouter.com) or just read the [docs](https://abrouter.com/en/docs). 
+You can create an experiment/feature flags and set up statistics and get your token and id of experiment on [ABRouter](https://abrouter.com) or just read the [docs](https://abrouter.com/en/docs). 
 
 
 ## Example

composer.json

@@ -15,9 +15,9 @@
         }
     ],
     "require": {
-        "php": "^5.5 || ^7.0 || ^8.0",
+        "php": "^7.4 || ^8.0",
         "laravel/framework": "^5.3 || ^6.0 || ^7.0 || ^8.0",
-        "abrouter/abrouter-php-client": "^0.8"
+        "abrouter/abrouter-php-client": "^0.10"
     },
     "extra": {
         "laravel": {

src/Bridge/KvStorage.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types = 1);
+
+namespace Abrouter\LaravelClient\Bridge;
+
+use Abrouter\Client\Contracts\KvStorageContract;
+use Illuminate\Support\Facades\Cache;
+
+class KvStorage implements KvStorageContract
+{
+    public function put(string $key, string $value, int $expiresInSeconds = 0): void
+    {
+        Cache::store()->put($key, $value, $expiresInSeconds);
+    }
+
+    public function remove(string $key): void
+    {
+        Cache::store()->delete($key);
+    }
+
+    public function get(string $key)
+    {
+        Cache::store()->get($key);
+    }
+}

src/Bridge/ParallelRunning/ParallelTaskContainer.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types = 1);
+
+namespace Abrouter\LaravelClient\Bridge\ParallelRunning;
+
+use Abrouter\Client\Contracts\TaskContract;
+
+class ParallelTaskContainer implements TaskContract
+{
+    private TaskContract $taskContract;
+
+    public function __construct(TaskContract $taskContract)
+    {
+        $this->taskContract = $taskContract;
+    }
+
+    /**
+     * @return TaskContract
+     */
+    public function getTaskContract(): TaskContract
+    {
+        return $this->taskContract;
+    }
+}

src/Bridge/ParallelRunning/ParallelTaskHandler.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types = 1);
+
+namespace Abrouter\LaravelClient\Bridge\ParallelRunning;
+
+use Abrouter\Client\Contracts\TaskContract;
+use Abrouter\Client\Events\EventDispatcher;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class ParallelTaskHandler implements TaskContract, ShouldQueue
+{
+    use InteractsWithQueue, Queueable, SerializesModels;
+
+    private EventDispatcher $eventDispatcher;
+
+    public function __construct(EventDispatcher $eventDispatcher)
+    {
+        $this->eventDispatcher = $eventDispatcher;
+    }
+
+    public function handle(ParallelTaskContainer $parallelTaskContainer)
+    {
+        $this->eventDispatcher->dispatch($parallelTaskContainer->getTaskContract());
+    }
+}

src/Bridge/ParallelRunning/TaskManager.php

@@ -0,0 +1,27 @@
+<?php
+declare(strict_types = 1);
+
+namespace Abrouter\LaravelClient\Bridge\ParallelRunning;
+
+use Abrouter\Client\Contracts\TaskContract;
+use Abrouter\Client\Contracts\TaskManagerContract;
+use Illuminate\Events\Dispatcher;
+
+class TaskManager implements TaskManagerContract
+{
+    private Dispatcher $dispatcher;
+
+    public function __construct(Dispatcher $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    public function queue(TaskContract $task): void
+    {
+        $this->dispatcher->dispatch(new ParallelTaskContainer($task));
+    }
+
+    public function work(int $iterationsLimit = 0): void
+    {
+    }
+}

src/Providers/AbrouterServiceProvider.php

@@ -4,11 +4,15 @@
 namespace Abrouter\LaravelClient\Providers;
 
 use Abrouter\Client\Config\Config;
+use Abrouter\Client\Config\ParallelRunConfig;
+use Abrouter\Client\Contracts\KvStorageContract;
+use Abrouter\Client\Contracts\TaskManagerContract;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Contracts\Foundation\Application;
 use RuntimeException;
 use Illuminate\Config\Repository;
+use Abrouter\LaravelClient\Bridge\KvStorage;
 
 /**
  * Class AbrouterServiceProvider
@@ -28,16 +32,29 @@ public function boot(): void
     public function register(): void
     {
         $this->mergeConfigFrom($this->configPath(), 'abrouter');
-        /**
-         * @var Repository $configRepository
-         */
-        $configRepository = $this->getContainer()->make(Repository::class);
-        
-        $this->getContainer()->singleton(Config::class, function () use ($configRepository) {
-            return new Config(
-                (string) $configRepository->get('abrouter.token'),
-                (string) $configRepository->get('abrouter.host')
-            );
+
+
+        $config = new Config(
+            (string) $this->getConfig()->get('abrouter.token'),
+            (string) $this->getConfig()->get('abrouter.host')
+        );
+
+        $kvStorageConfigured = false;
+        if ($this->configureKvStorage()) {
+            $config->setKvStorageConfig($this->getContainer()->make(KvStorageContract::class));
+            $kvStorageConfigured = true;
+        }
+
+        if ($kvStorageConfigured && $this->isParallelRunningEnabled()) {
+            $this->configureParallelRunning();
+            $config->setParallelRunConfig(new ParallelRunConfig(
+                true,
+                $this->getContainer()->make(TaskManagerContract::class),
+            ));
+        }
+
+        $this->getContainer()->singleton(Config::class, function () use ($config) {
+            return $config;
         });
     }
 
@@ -80,4 +97,59 @@ private function getApplicationConfigPath(): string
     {
         return $this->app->configPath('abrouter.php');
     }
+
+    private function configureKvStorage(): bool
+    {
+        $kvStorage = $this->getConfig()->get('abrouter.kvStorage');
+        if (empty($kvStorage)) {
+            return false;
+        }
+
+        $this->getContainer()->singleton(KvStorageContract::class, function () use ($kvStorage) {
+            return $this->getContainer()->make($kvStorage);
+        });
+
+        return true;
+    }
+
+    private function isParallelRunningEnabled(): bool
+    {
+        $parallelRunningConfig = $this->getConfig()->get('abrouter.parallelRunning');
+
+        if (!is_array($parallelRunningConfig)) {
+            return false;
+        }
+
+        if (!isset($parallelRunningConfig['enabled'])) {
+            return false;
+        }
+
+        if (empty($parallelRunningConfig['taskManager'])) {
+            return false;
+        }
+
+        return (bool) $parallelRunningConfig['enabled'];
+    }
+
+    private function configureParallelRunning(): void
+    {
+        $taskManager = $this->getConfig()->get('abrouter.parallelRunning.taskManager');
+        if (empty($taskManager)) {
+            throw new RuntimeException('TaskManager class is not configured');
+        }
+
+        $this->getContainer()->singleton(TaskManagerContract::class, function () use ($taskManager) {
+            return $this->getContainer()->make($taskManager);
+        });
+        $this->getContainer()->register(EventServiceProvider::class);
+    }
+
+    private function getConfig(): Repository
+    {
+        /**
+         * @var Repository $configRepository
+         */
+        $configRepository = $this->getContainer()->make(Repository::class);
+        return $configRepository;
+    }
 }

src/Providers/EventServiceProvider.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types = 1);
+
+namespace Abrouter\LaravelClient\Providers;
+
+use Abrouter\LaravelClient\Bridge\ParallelRunning\ParallelTaskContainer;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+use Abrouter\LaravelClient\Bridge\ParallelRunning\ParallelTaskHandler;
+
+class EventServiceProvider extends ServiceProvider
+{
+    protected $listen = [
+        ParallelTaskContainer::class => [
+            ParallelTaskHandler::class,
+        ]
+    ];
+}