Skip to content

Add plugin client builder #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions src/PluginClientBuilder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?php

declare(strict_types=1);

namespace Http\Client\Common;

use Http\Client\HttpAsyncClient;
use Psr\Http\Client\ClientInterface;

/**
* Build an instance of a PluginClient with a dynamic list of plugins.
*
* @author Baptiste Clavié <clavie.b@gmail.com>
*/
final class PluginClientBuilder
{
/** @var Plugin[][] List of plugins ordered by priority [priority => Plugin[]]). */
private $plugins = [];

/** @var array Array of options to give to the plugin client */
private $options = [];

/**
* @param int $priority Priority of the plugin. The higher comes first.
*/
public function addPlugin(Plugin $plugin, int $priority = 0): self
{
$this->plugins[$priority][] = $plugin;

return $this;
}

public function setOption(string $name, $value): self
{
$this->options[$name] = $value;

return $this;
}

public function removeOption(string $name): self
{
unset($this->options[$name]);

return $this;
}

/**
* @param ClientInterface | HttpAsyncClient $client
*/
public function createClient($client): PluginClient
{
if (!$client instanceof ClientInterface && !$client instanceof HttpAsyncClient) {
throw new \RuntimeException('You must provide a valid http client');
}

$plugins = $this->plugins;

if (0 === count($plugins)) {
$plugins[] = [];
}

krsort($plugins);
$plugins = array_merge(...$plugins);

return new PluginClient(
$client,
array_values($plugins),
$this->options
);
}
}
80 changes: 80 additions & 0 deletions tests/PluginClientBuilderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php

declare(strict_types=1);

namespace tests\Http\Client\Common;

use Closure;
use Http\Client\Common\Plugin;
use Http\Client\Common\PluginClient;
use Http\Client\Common\PluginClientBuilder;
use Http\Client\HttpAsyncClient;
use Http\Client\HttpClient;
use PHPUnit\Framework\TestCase;

class PluginClientBuilderTest extends TestCase
{
/** @dataProvider clientProvider */
public function testPriority(string $client): void
{
$builder = new PluginClientBuilder();

$plugins = [
10 => $this->prophesize(Plugin::class)->reveal(),
-10 => $this->prophesize(Plugin::class)->reveal(),
0 => $this->prophesize(Plugin::class)->reveal(),
];

foreach ($plugins as $priority => $plugin) {
$builder->addPlugin($plugin, $priority);
}

$client = $this->prophesize($client)->reveal();
$client = $builder->createClient($client);

$closure = Closure::bind(
function (): array {
return $this->plugins;
},
$client,
PluginClient::class
);

$plugged = $closure();

$expected = $plugins;
krsort($expected);
$expected = array_values($expected);

$this->assertSame($expected, $plugged);
}

/** @dataProvider clientProvider */
public function testOptions(string $client): void
{
$builder = new PluginClientBuilder();
$builder->setOption('max_restarts', 5);

$client = $this->prophesize($client)->reveal();
$client = $builder->createClient($client);

$closure = Closure::bind(
function (): array {
return $this->options;
},
$client,
PluginClient::class
);

$options = $closure();

$this->assertArrayHasKey('max_restarts', $options);
$this->assertSame(5, $options['max_restarts']);
}

public function clientProvider(): iterable
{
yield 'sync\'d http client' => [HttpClient::class];
yield 'async\'d http client' => [HttpAsyncClient::class];
}
}