mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-27 16:26:37 +03:00
Code Issues Projects Releases Packages Wiki Activity

Refactored Rest ConfigProvider so that it appends the health action with and without version

Browse source
This commit is contained in:
Alejandro Celaya 2020-01-07 18:07:51 +01:00
parent 36d5e057d0
commit 2b544ad141
2 changed files with 61 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
module/Rest/src/ConfigProvider.php
View file

@ -6,6 +6,8 @@ namespace Shlinkio\Shlink\Rest;
use Closure;
use function Functional\first;
use function Functional\map;
use function Shlinkio\Shlink\Common\loadConfigFromGlob;
use function sprintf;
@ -30,21 +32,33 @@ class ConfigProvider
private function applyRoutesPrefix(array $config): array
{
$routes =& $config['routes'] ?? [];
$routes = $config['routes'] ?? [];
$healthRoute = $this->buildUnversionedHealthRouteFromExistingRoutes($routes);
// Prepend the routes prefix to every path
foreach ($routes as $key => $route) {
$prefixRoute = static function (array $route) {
['path' => $path] = $route;
$routes[$key]['path'] = sprintf('%s%s', self::ROUTES_PREFIX, $path);
$route['path'] = sprintf('%s%s', self::ROUTES_PREFIX, $path);
// Also append the health route so that it works without version
if ($path === '/health') {
$route['path'] = sprintf('%s%s', self::UNVERSIONED_ROUTES_PREFIX, $path);
$route['name'] = self::UNVERSIONED_HEALTH_ENDPOINT_NAME;
$routes[] = $route;
}
}
return $route;
};
$prefixedRoutes = map($routes, $prefixRoute);
$config['routes'] = $healthRoute !== null ? [...$prefixedRoutes, $healthRoute] : $prefixedRoutes;
return $config;
}
private function buildUnversionedHealthRouteFromExistingRoutes(array $routes): ?array
{
$healthRoute = first($routes, fn (array $route) => $route['path'] === '/health');
if ($healthRoute === null) {
return null;
}
$path = $healthRoute['path'];
$healthRoute['path'] = sprintf('%s%s', self::UNVERSIONED_ROUTES_PREFIX, $path);
$healthRoute['name'] = self::UNVERSIONED_HEALTH_ENDPOINT_NAME;
return $healthRoute;
}
}

51
module/Rest/test/ConfigProviderTest.php
View file

@ -25,26 +25,47 @@ class ConfigProviderTest extends TestCase
$this->assertArrayHasKey('dependencies', $config);
}
/** @test */
public function routesAreProperlyPrefixed(): void
/**
* @test
* @dataProvider provideRoutesConfig
*/
public function routesAreProperlyPrefixed(array $routes, array $expected): void
{
$configProvider = new ConfigProvider(fn () => [
'routes' => [
$configProvider = new ConfigProvider(fn () => ['routes' => $routes]);
$config = $configProvider();
$this->assertEquals($expected, $config['routes']);
}
public function provideRoutesConfig(): iterable
{
yield 'health action present' => [
[
['path' => '/foo'],
['path' => '/bar'],
['path' => '/baz/foo'],
['path' => '/health'],
],
]);
$config = $configProvider();
$this->assertEquals([
['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar'],
['path' => '/rest/v{version:1|2}/baz/foo'],
['path' => '/rest/v{version:1|2}/health'],
['path' => '/rest/health', 'name' => ConfigProvider::UNVERSIONED_HEALTH_ENDPOINT_NAME],
], $config['routes']);
[
['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar'],
['path' => '/rest/v{version:1|2}/baz/foo'],
['path' => '/rest/v{version:1|2}/health'],
['path' => '/rest/health', 'name' => ConfigProvider::UNVERSIONED_HEALTH_ENDPOINT_NAME],
],
];
yield 'health action not present' => [
[
['path' => '/foo'],
['path' => '/bar'],
['path' => '/baz/foo'],
],
[
['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar'],
['path' => '/rest/v{version:1|2}/baz/foo'],
],
];
}
}