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

Merge pull request #603 from acelaya-forks/feature/versioned-health

Browse source 
Feature/versioned health
This commit is contained in:
Alejandro Celaya 2020-01-07 18:15:17 +01:00 committed by GitHub
commit c0881f9292
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 65 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -34,7 +34,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
#### Fixed
* *Nothing*
* [#600](https://github.com/shlinkio/shlink/issues/600) Fixed health action so that it works with and without version in the path.
## 1.21.1 - 2020-01-02

1
module/Rest/config/auth.config.php
View file

@ -12,6 +12,7 @@ return [
'routes_whitelist' => [
Action\HealthAction::class,
Action\ShortUrl\SingleStepCreateShortUrlAction::class,
ConfigProvider::UNVERSIONED_HEALTH_ENDPOINT_NAME,
],
'plugins' => [

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;
@ -13,6 +15,7 @@ class ConfigProvider
{
private const ROUTES_PREFIX = '/rest/v{version:1|2}';
private const UNVERSIONED_ROUTES_PREFIX = '/rest';
public const UNVERSIONED_HEALTH_ENDPOINT_NAME = 'unversioned_health';
private Closure $loadConfig;
@ -29,18 +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',
$path === '/health' ? self::UNVERSIONED_ROUTES_PREFIX : self::ROUTES_PREFIX,
$path,
);
}
$route['path'] = sprintf('%s%s', self::ROUTES_PREFIX, $path);
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;
}
}

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

@ -25,25 +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/health'],
], $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'],
],
];
}
}