mirror of
https://github.com/shlinkio/shlink.git
synced 2025-02-25 18:45:27 -06:00
Added support to define differnet not-found redirects per domain
This commit is contained in:
parent
2054784a4a
commit
4d48482d1e
@ -2,13 +2,16 @@
|
|||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
$isSwoole = extension_loaded('swoole');
|
||||||
|
|
||||||
return [
|
return [
|
||||||
|
|
||||||
'url_shortener' => [
|
'url_shortener' => [
|
||||||
'domain' => [
|
'domain' => [
|
||||||
'schema' => 'http',
|
'schema' => 'http',
|
||||||
'hostname' => 'localhost:8080',
|
'hostname' => sprintf('localhost:%s', $isSwoole ? '8080' : '8000'),
|
||||||
],
|
],
|
||||||
|
'auto_resolve_titles' => true,
|
||||||
],
|
],
|
||||||
|
|
||||||
];
|
];
|
||||||
|
41
data/migrations/Version20210720143824.php
Normal file
41
data/migrations/Version20210720143824.php
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace ShlinkMigrations;
|
||||||
|
|
||||||
|
use Doctrine\DBAL\Schema\Schema;
|
||||||
|
use Doctrine\DBAL\Schema\Table;
|
||||||
|
use Doctrine\DBAL\Types\Types;
|
||||||
|
use Doctrine\Migrations\AbstractMigration;
|
||||||
|
|
||||||
|
final class Version20210720143824 extends AbstractMigration
|
||||||
|
{
|
||||||
|
public function up(Schema $schema): void
|
||||||
|
{
|
||||||
|
$domainsTable = $schema->getTable('domains');
|
||||||
|
$this->skipIf($domainsTable->hasColumn('base_url_redirect'));
|
||||||
|
|
||||||
|
$this->createRedirectColumn($domainsTable, 'base_url_redirect');
|
||||||
|
$this->createRedirectColumn($domainsTable, 'regular_not_found_redirect');
|
||||||
|
$this->createRedirectColumn($domainsTable, 'invalid_short_url_redirect');
|
||||||
|
}
|
||||||
|
|
||||||
|
private function createRedirectColumn(Table $table, string $columnName): void
|
||||||
|
{
|
||||||
|
$table->addColumn($columnName, Types::STRING, [
|
||||||
|
'notnull' => false,
|
||||||
|
'default' => null,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(Schema $schema): void
|
||||||
|
{
|
||||||
|
$domainsTable = $schema->getTable('domains');
|
||||||
|
$this->skipIf(! $domainsTable->hasColumn('base_url_redirect'));
|
||||||
|
|
||||||
|
$domainsTable->dropColumn('base_url_redirect');
|
||||||
|
$domainsTable->dropColumn('regular_not_found_redirect');
|
||||||
|
$domainsTable->dropColumn('invalid_short_url_redirect');
|
||||||
|
}
|
||||||
|
}
|
@ -46,6 +46,8 @@ return [
|
|||||||
Util\DoctrineBatchHelper::class => ConfigAbstractFactory::class,
|
Util\DoctrineBatchHelper::class => ConfigAbstractFactory::class,
|
||||||
Util\RedirectResponseHelper::class => ConfigAbstractFactory::class,
|
Util\RedirectResponseHelper::class => ConfigAbstractFactory::class,
|
||||||
|
|
||||||
|
Config\NotFoundRedirectResolver::class => ConfigAbstractFactory::class,
|
||||||
|
|
||||||
Action\RedirectAction::class => ConfigAbstractFactory::class,
|
Action\RedirectAction::class => ConfigAbstractFactory::class,
|
||||||
Action\PixelAction::class => ConfigAbstractFactory::class,
|
Action\PixelAction::class => ConfigAbstractFactory::class,
|
||||||
Action\QrCodeAction::class => ConfigAbstractFactory::class,
|
Action\QrCodeAction::class => ConfigAbstractFactory::class,
|
||||||
@ -75,7 +77,8 @@ return [
|
|||||||
ErrorHandler\NotFoundTrackerMiddleware::class => [Visit\RequestTracker::class],
|
ErrorHandler\NotFoundTrackerMiddleware::class => [Visit\RequestTracker::class],
|
||||||
ErrorHandler\NotFoundRedirectHandler::class => [
|
ErrorHandler\NotFoundRedirectHandler::class => [
|
||||||
NotFoundRedirectOptions::class,
|
NotFoundRedirectOptions::class,
|
||||||
Util\RedirectResponseHelper::class,
|
Config\NotFoundRedirectResolver::class,
|
||||||
|
Domain\DomainService::class,
|
||||||
],
|
],
|
||||||
|
|
||||||
Options\AppOptions::class => ['config.app_options'],
|
Options\AppOptions::class => ['config.app_options'],
|
||||||
@ -118,6 +121,8 @@ return [
|
|||||||
Util\DoctrineBatchHelper::class => ['em'],
|
Util\DoctrineBatchHelper::class => ['em'],
|
||||||
Util\RedirectResponseHelper::class => [Options\UrlShortenerOptions::class],
|
Util\RedirectResponseHelper::class => [Options\UrlShortenerOptions::class],
|
||||||
|
|
||||||
|
Config\NotFoundRedirectResolver::class => [Util\RedirectResponseHelper::class],
|
||||||
|
|
||||||
Action\RedirectAction::class => [
|
Action\RedirectAction::class => [
|
||||||
Service\ShortUrl\ShortUrlResolver::class,
|
Service\ShortUrl\ShortUrlResolver::class,
|
||||||
Visit\RequestTracker::class,
|
Visit\RequestTracker::class,
|
||||||
|
@ -24,4 +24,19 @@ return static function (ClassMetadata $metadata, array $emConfig): void {
|
|||||||
$builder->createField('authority', Types::STRING)
|
$builder->createField('authority', Types::STRING)
|
||||||
->unique()
|
->unique()
|
||||||
->build();
|
->build();
|
||||||
|
|
||||||
|
$builder->createField('baseUrlRedirect', Types::STRING)
|
||||||
|
->columnName('base_url_redirect')
|
||||||
|
->nullable()
|
||||||
|
->build();
|
||||||
|
|
||||||
|
$builder->createField('regular404Redirect', Types::STRING)
|
||||||
|
->columnName('regular_not_found_redirect')
|
||||||
|
->nullable()
|
||||||
|
->build();
|
||||||
|
|
||||||
|
$builder->createField('invalidShortUrlRedirect', Types::STRING)
|
||||||
|
->columnName('invalid_short_url_redirect')
|
||||||
|
->nullable()
|
||||||
|
->build();
|
||||||
};
|
};
|
||||||
|
20
module/Core/src/Config/NotFoundRedirectConfigInterface.php
Normal file
20
module/Core/src/Config/NotFoundRedirectConfigInterface.php
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Shlinkio\Shlink\Core\Config;
|
||||||
|
|
||||||
|
interface NotFoundRedirectConfigInterface
|
||||||
|
{
|
||||||
|
public function invalidShortUrlRedirect(): ?string;
|
||||||
|
|
||||||
|
public function hasInvalidShortUrlRedirect(): bool;
|
||||||
|
|
||||||
|
public function regular404Redirect(): ?string;
|
||||||
|
|
||||||
|
public function hasRegular404Redirect(): bool;
|
||||||
|
|
||||||
|
public function baseUrlRedirect(): ?string;
|
||||||
|
|
||||||
|
public function hasBaseUrlRedirect(): bool;
|
||||||
|
}
|
34
module/Core/src/Config/NotFoundRedirectResolver.php
Normal file
34
module/Core/src/Config/NotFoundRedirectResolver.php
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Shlinkio\Shlink\Core\Config;
|
||||||
|
|
||||||
|
use Psr\Http\Message\ResponseInterface;
|
||||||
|
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
||||||
|
use Shlinkio\Shlink\Core\Util\RedirectResponseHelperInterface;
|
||||||
|
|
||||||
|
class NotFoundRedirectResolver implements NotFoundRedirectResolverInterface
|
||||||
|
{
|
||||||
|
public function __construct(private RedirectResponseHelperInterface $redirectResponseHelper)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
public function resolveRedirectResponse(
|
||||||
|
NotFoundType $notFoundType,
|
||||||
|
NotFoundRedirectConfigInterface $config
|
||||||
|
): ?ResponseInterface {
|
||||||
|
return match (true) {
|
||||||
|
$notFoundType->isBaseUrl() && $config->hasBaseUrlRedirect() =>
|
||||||
|
// @phpstan-ignore-next-line Create custom PHPStan rule
|
||||||
|
$this->redirectResponseHelper->buildRedirectResponse($config->baseUrlRedirect()),
|
||||||
|
$notFoundType->isRegularNotFound() && $config->hasRegular404Redirect() =>
|
||||||
|
// @phpstan-ignore-next-line Create custom PHPStan rule
|
||||||
|
$this->redirectResponseHelper->buildRedirectResponse($config->regular404Redirect()),
|
||||||
|
$notFoundType->isInvalidShortUrl() && $config->hasInvalidShortUrlRedirect() =>
|
||||||
|
// @phpstan-ignore-next-line Create custom PHPStan rule
|
||||||
|
$this->redirectResponseHelper->buildRedirectResponse($config->invalidShortUrlRedirect()),
|
||||||
|
default => null,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
16
module/Core/src/Config/NotFoundRedirectResolverInterface.php
Normal file
16
module/Core/src/Config/NotFoundRedirectResolverInterface.php
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Shlinkio\Shlink\Core\Config;
|
||||||
|
|
||||||
|
use Psr\Http\Message\ResponseInterface;
|
||||||
|
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
||||||
|
|
||||||
|
interface NotFoundRedirectResolverInterface
|
||||||
|
{
|
||||||
|
public function resolveRedirectResponse(
|
||||||
|
NotFoundType $notFoundType,
|
||||||
|
NotFoundRedirectConfigInterface $config
|
||||||
|
): ?ResponseInterface;
|
||||||
|
}
|
@ -54,10 +54,15 @@ class DomainService implements DomainServiceInterface
|
|||||||
return $domain;
|
return $domain;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getOrCreate(string $authority): Domain
|
public function findByAuthority(string $authority): ?Domain
|
||||||
{
|
{
|
||||||
$repo = $this->em->getRepository(Domain::class);
|
$repo = $this->em->getRepository(Domain::class);
|
||||||
$domain = $repo->findOneBy(['authority' => $authority]) ?? new Domain($authority);
|
return $repo->findOneBy(['authority' => $authority]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getOrCreate(string $authority): Domain
|
||||||
|
{
|
||||||
|
$domain = $this->findByAuthority($authority) ?? new Domain($authority);
|
||||||
|
|
||||||
$this->em->persist($domain);
|
$this->em->persist($domain);
|
||||||
$this->em->flush();
|
$this->em->flush();
|
||||||
|
@ -22,4 +22,6 @@ interface DomainServiceInterface
|
|||||||
public function getDomain(string $domainId): Domain;
|
public function getDomain(string $domainId): Domain;
|
||||||
|
|
||||||
public function getOrCreate(string $authority): Domain;
|
public function getOrCreate(string $authority): Domain;
|
||||||
|
|
||||||
|
public function findByAuthority(string $authority): ?Domain;
|
||||||
}
|
}
|
||||||
|
@ -6,9 +6,14 @@ namespace Shlinkio\Shlink\Core\Entity;
|
|||||||
|
|
||||||
use JsonSerializable;
|
use JsonSerializable;
|
||||||
use Shlinkio\Shlink\Common\Entity\AbstractEntity;
|
use Shlinkio\Shlink\Common\Entity\AbstractEntity;
|
||||||
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectConfigInterface;
|
||||||
|
|
||||||
class Domain extends AbstractEntity implements JsonSerializable
|
class Domain extends AbstractEntity implements JsonSerializable, NotFoundRedirectConfigInterface
|
||||||
{
|
{
|
||||||
|
private ?string $baseUrlRedirect = null;
|
||||||
|
private ?string $regular404Redirect = null;
|
||||||
|
private ?string $invalidShortUrlRedirect = null;
|
||||||
|
|
||||||
public function __construct(private string $authority)
|
public function __construct(private string $authority)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
@ -22,4 +27,34 @@ class Domain extends AbstractEntity implements JsonSerializable
|
|||||||
{
|
{
|
||||||
return $this->getAuthority();
|
return $this->getAuthority();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function invalidShortUrlRedirect(): ?string
|
||||||
|
{
|
||||||
|
return $this->invalidShortUrlRedirect;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function hasInvalidShortUrlRedirect(): bool
|
||||||
|
{
|
||||||
|
return $this->invalidShortUrlRedirect !== null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function regular404Redirect(): ?string
|
||||||
|
{
|
||||||
|
return $this->regular404Redirect;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function hasRegular404Redirect(): bool
|
||||||
|
{
|
||||||
|
return $this->regular404Redirect !== null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function baseUrlRedirect(): ?string
|
||||||
|
{
|
||||||
|
return $this->baseUrlRedirect;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function hasBaseUrlRedirect(): bool
|
||||||
|
{
|
||||||
|
return $this->baseUrlRedirect !== null;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -8,15 +8,17 @@ use Psr\Http\Message\ResponseInterface;
|
|||||||
use Psr\Http\Message\ServerRequestInterface;
|
use Psr\Http\Message\ServerRequestInterface;
|
||||||
use Psr\Http\Server\MiddlewareInterface;
|
use Psr\Http\Server\MiddlewareInterface;
|
||||||
use Psr\Http\Server\RequestHandlerInterface;
|
use Psr\Http\Server\RequestHandlerInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectResolverInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
|
||||||
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
||||||
use Shlinkio\Shlink\Core\Options;
|
use Shlinkio\Shlink\Core\Options;
|
||||||
use Shlinkio\Shlink\Core\Util\RedirectResponseHelperInterface;
|
|
||||||
|
|
||||||
class NotFoundRedirectHandler implements MiddlewareInterface
|
class NotFoundRedirectHandler implements MiddlewareInterface
|
||||||
{
|
{
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private Options\NotFoundRedirectOptions $redirectOptions,
|
private Options\NotFoundRedirectOptions $redirectOptions,
|
||||||
private RedirectResponseHelperInterface $redirectResponseHelper
|
private NotFoundRedirectResolverInterface $redirectResolver,
|
||||||
|
private DomainServiceInterface $domainService,
|
||||||
) {
|
) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -24,26 +26,17 @@ class NotFoundRedirectHandler implements MiddlewareInterface
|
|||||||
{
|
{
|
||||||
/** @var NotFoundType $notFoundType */
|
/** @var NotFoundType $notFoundType */
|
||||||
$notFoundType = $request->getAttribute(NotFoundType::class);
|
$notFoundType = $request->getAttribute(NotFoundType::class);
|
||||||
|
$authority = $request->getUri()->getAuthority();
|
||||||
|
$domainSpecificRedirect = $this->resolveDomainSpecificRedirect($authority, $notFoundType);
|
||||||
|
|
||||||
if ($notFoundType->isBaseUrl() && $this->redirectOptions->hasBaseUrlRedirect()) {
|
return $domainSpecificRedirect
|
||||||
// @phpstan-ignore-next-line Create custom PHPStan rule
|
?? $this->redirectResolver->resolveRedirectResponse($notFoundType, $this->redirectOptions)
|
||||||
return $this->redirectResponseHelper->buildRedirectResponse($this->redirectOptions->getBaseUrlRedirect());
|
?? $handler->handle($request);
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($notFoundType->isRegularNotFound() && $this->redirectOptions->hasRegular404Redirect()) {
|
private function resolveDomainSpecificRedirect(string $authority, NotFoundType $notFoundType): ?ResponseInterface
|
||||||
return $this->redirectResponseHelper->buildRedirectResponse(
|
{
|
||||||
// @phpstan-ignore-next-line Create custom PHPStan rule
|
$domain = $this->domainService->findByAuthority($authority);
|
||||||
$this->redirectOptions->getRegular404Redirect(),
|
return $domain === null ? null : $this->redirectResolver->resolveRedirectResponse($notFoundType, $domain);
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($notFoundType->isInvalidShortUrl() && $this->redirectOptions->hasInvalidShortUrlRedirect()) {
|
|
||||||
return $this->redirectResponseHelper->buildRedirectResponse(
|
|
||||||
// @phpstan-ignore-next-line Create custom PHPStan rule
|
|
||||||
$this->redirectOptions->getInvalidShortUrlRedirect(),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $handler->handle($request);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -5,14 +5,15 @@ declare(strict_types=1);
|
|||||||
namespace Shlinkio\Shlink\Core\Options;
|
namespace Shlinkio\Shlink\Core\Options;
|
||||||
|
|
||||||
use Laminas\Stdlib\AbstractOptions;
|
use Laminas\Stdlib\AbstractOptions;
|
||||||
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectConfigInterface;
|
||||||
|
|
||||||
class NotFoundRedirectOptions extends AbstractOptions
|
class NotFoundRedirectOptions extends AbstractOptions implements NotFoundRedirectConfigInterface
|
||||||
{
|
{
|
||||||
private ?string $invalidShortUrl = null;
|
private ?string $invalidShortUrl = null;
|
||||||
private ?string $regular404 = null;
|
private ?string $regular404 = null;
|
||||||
private ?string $baseUrl = null;
|
private ?string $baseUrl = null;
|
||||||
|
|
||||||
public function getInvalidShortUrlRedirect(): ?string
|
public function invalidShortUrlRedirect(): ?string
|
||||||
{
|
{
|
||||||
return $this->invalidShortUrl;
|
return $this->invalidShortUrl;
|
||||||
}
|
}
|
||||||
@ -28,7 +29,7 @@ class NotFoundRedirectOptions extends AbstractOptions
|
|||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getRegular404Redirect(): ?string
|
public function regular404Redirect(): ?string
|
||||||
{
|
{
|
||||||
return $this->regular404;
|
return $this->regular404;
|
||||||
}
|
}
|
||||||
@ -44,7 +45,7 @@ class NotFoundRedirectOptions extends AbstractOptions
|
|||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getBaseUrlRedirect(): ?string
|
public function baseUrlRedirect(): ?string
|
||||||
{
|
{
|
||||||
return $this->baseUrl;
|
return $this->baseUrl;
|
||||||
}
|
}
|
||||||
|
114
module/Core/test/Config/NotFoundRedirectResolverTest.php
Normal file
114
module/Core/test/Config/NotFoundRedirectResolverTest.php
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace ShlinkioTest\Shlink\Core\Config;
|
||||||
|
|
||||||
|
use Laminas\Diactoros\Response;
|
||||||
|
use Laminas\Diactoros\ServerRequestFactory;
|
||||||
|
use Laminas\Diactoros\Uri;
|
||||||
|
use Mezzio\Router\Route;
|
||||||
|
use Mezzio\Router\RouteResult;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Prophecy\Argument;
|
||||||
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Prophecy\Prophecy\ObjectProphecy;
|
||||||
|
use Psr\Http\Message\ServerRequestInterface;
|
||||||
|
use Psr\Http\Server\MiddlewareInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Action\RedirectAction;
|
||||||
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectConfigInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectResolver;
|
||||||
|
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
||||||
|
use Shlinkio\Shlink\Core\Options\NotFoundRedirectOptions;
|
||||||
|
use Shlinkio\Shlink\Core\Util\RedirectResponseHelperInterface;
|
||||||
|
|
||||||
|
class NotFoundRedirectResolverTest extends TestCase
|
||||||
|
{
|
||||||
|
use ProphecyTrait;
|
||||||
|
|
||||||
|
private NotFoundRedirectResolver $resolver;
|
||||||
|
private ObjectProphecy $helper;
|
||||||
|
private NotFoundRedirectConfigInterface $config;
|
||||||
|
|
||||||
|
protected function setUp(): void
|
||||||
|
{
|
||||||
|
$this->helper = $this->prophesize(RedirectResponseHelperInterface::class);
|
||||||
|
$this->resolver = new NotFoundRedirectResolver($this->helper->reveal());
|
||||||
|
|
||||||
|
$this->config = new NotFoundRedirectOptions([
|
||||||
|
'invalidShortUrl' => 'invalidShortUrl',
|
||||||
|
'regular404' => 'regular404',
|
||||||
|
'baseUrl' => 'baseUrl',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @test
|
||||||
|
* @dataProvider provideRedirects
|
||||||
|
*/
|
||||||
|
public function expectedRedirectionIsReturnedDependingOnTheCase(
|
||||||
|
NotFoundType $notFoundType,
|
||||||
|
string $expectedRedirectTo,
|
||||||
|
): void {
|
||||||
|
$expectedResp = new Response();
|
||||||
|
$buildResp = $this->helper->buildRedirectResponse($expectedRedirectTo)->willReturn($expectedResp);
|
||||||
|
|
||||||
|
$resp = $this->resolver->resolveRedirectResponse($notFoundType, $this->config);
|
||||||
|
|
||||||
|
self::assertSame($expectedResp, $resp);
|
||||||
|
$buildResp->shouldHaveBeenCalledOnce();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function provideRedirects(): iterable
|
||||||
|
{
|
||||||
|
yield 'base URL with trailing slash' => [
|
||||||
|
$this->notFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri('/'))),
|
||||||
|
'baseUrl',
|
||||||
|
];
|
||||||
|
yield 'base URL without trailing slash' => [
|
||||||
|
$this->notFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri(''))),
|
||||||
|
'baseUrl',
|
||||||
|
];
|
||||||
|
yield 'regular 404' => [
|
||||||
|
$this->notFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri('/foo/bar'))),
|
||||||
|
'regular404',
|
||||||
|
];
|
||||||
|
yield 'invalid short URL' => [
|
||||||
|
$this->notFoundType($this->requestForRoute(RedirectAction::class)),
|
||||||
|
'invalidShortUrl',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function noResponseIsReturnedIfNoConditionsMatch(): void
|
||||||
|
{
|
||||||
|
$notFoundType = $this->notFoundType($this->requestForRoute('foo'));
|
||||||
|
|
||||||
|
$result = $this->resolver->resolveRedirectResponse($notFoundType, $this->config);
|
||||||
|
|
||||||
|
self::assertNull($result);
|
||||||
|
$this->helper->buildRedirectResponse(Argument::cetera())->shouldNotHaveBeenCalled();
|
||||||
|
}
|
||||||
|
|
||||||
|
private function notFoundType(ServerRequestInterface $req): NotFoundType
|
||||||
|
{
|
||||||
|
return NotFoundType::fromRequest($req, '');
|
||||||
|
}
|
||||||
|
|
||||||
|
private function requestForRoute(string $routeName): ServerRequestInterface
|
||||||
|
{
|
||||||
|
return ServerRequestFactory::fromGlobals()
|
||||||
|
->withAttribute(
|
||||||
|
RouteResult::class,
|
||||||
|
RouteResult::fromRoute(
|
||||||
|
new Route(
|
||||||
|
'',
|
||||||
|
$this->prophesize(MiddlewareInterface::class)->reveal(),
|
||||||
|
['GET'],
|
||||||
|
$routeName,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
->withUri(new Uri('/abc123'));
|
||||||
|
}
|
||||||
|
}
|
@ -6,21 +6,18 @@ namespace ShlinkioTest\Shlink\Core\ErrorHandler;
|
|||||||
|
|
||||||
use Laminas\Diactoros\Response;
|
use Laminas\Diactoros\Response;
|
||||||
use Laminas\Diactoros\ServerRequestFactory;
|
use Laminas\Diactoros\ServerRequestFactory;
|
||||||
use Laminas\Diactoros\Uri;
|
|
||||||
use Mezzio\Router\Route;
|
|
||||||
use Mezzio\Router\RouteResult;
|
|
||||||
use PHPUnit\Framework\TestCase;
|
use PHPUnit\Framework\TestCase;
|
||||||
use Prophecy\Argument;
|
use Prophecy\Argument;
|
||||||
use Prophecy\PhpUnit\ProphecyTrait;
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
use Prophecy\Prophecy\ObjectProphecy;
|
use Prophecy\Prophecy\ObjectProphecy;
|
||||||
use Psr\Http\Message\ServerRequestInterface;
|
use Psr\Http\Message\ServerRequestInterface;
|
||||||
use Psr\Http\Server\MiddlewareInterface;
|
|
||||||
use Psr\Http\Server\RequestHandlerInterface;
|
use Psr\Http\Server\RequestHandlerInterface;
|
||||||
use Shlinkio\Shlink\Core\Action\RedirectAction;
|
use Shlinkio\Shlink\Core\Config\NotFoundRedirectResolverInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
|
||||||
|
use Shlinkio\Shlink\Core\Entity\Domain;
|
||||||
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
use Shlinkio\Shlink\Core\ErrorHandler\Model\NotFoundType;
|
||||||
use Shlinkio\Shlink\Core\ErrorHandler\NotFoundRedirectHandler;
|
use Shlinkio\Shlink\Core\ErrorHandler\NotFoundRedirectHandler;
|
||||||
use Shlinkio\Shlink\Core\Options\NotFoundRedirectOptions;
|
use Shlinkio\Shlink\Core\Options\NotFoundRedirectOptions;
|
||||||
use Shlinkio\Shlink\Core\Util\RedirectResponseHelperInterface;
|
|
||||||
|
|
||||||
class NotFoundRedirectHandlerTest extends TestCase
|
class NotFoundRedirectHandlerTest extends TestCase
|
||||||
{
|
{
|
||||||
@ -28,93 +25,103 @@ class NotFoundRedirectHandlerTest extends TestCase
|
|||||||
|
|
||||||
private NotFoundRedirectHandler $middleware;
|
private NotFoundRedirectHandler $middleware;
|
||||||
private NotFoundRedirectOptions $redirectOptions;
|
private NotFoundRedirectOptions $redirectOptions;
|
||||||
private ObjectProphecy $helper;
|
private ObjectProphecy $resolver;
|
||||||
|
private ObjectProphecy $domainService;
|
||||||
|
private ObjectProphecy $next;
|
||||||
|
private ServerRequestInterface $req;
|
||||||
|
|
||||||
public function setUp(): void
|
public function setUp(): void
|
||||||
{
|
{
|
||||||
$this->redirectOptions = new NotFoundRedirectOptions();
|
$this->redirectOptions = new NotFoundRedirectOptions();
|
||||||
$this->helper = $this->prophesize(RedirectResponseHelperInterface::class);
|
$this->resolver = $this->prophesize(NotFoundRedirectResolverInterface::class);
|
||||||
$this->middleware = new NotFoundRedirectHandler($this->redirectOptions, $this->helper->reveal());
|
$this->domainService = $this->prophesize(DomainServiceInterface::class);
|
||||||
|
|
||||||
|
$this->middleware = new NotFoundRedirectHandler(
|
||||||
|
$this->redirectOptions,
|
||||||
|
$this->resolver->reveal(),
|
||||||
|
$this->domainService->reveal(),
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->next = $this->prophesize(RequestHandlerInterface::class);
|
||||||
|
$this->req = ServerRequestFactory::fromGlobals()->withAttribute(
|
||||||
|
NotFoundType::class,
|
||||||
|
$this->prophesize(NotFoundType::class)->reveal(),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @test
|
* @test
|
||||||
* @dataProvider provideRedirects
|
* @dataProvider provideNonRedirectScenarios
|
||||||
*/
|
*/
|
||||||
public function expectedRedirectionIsReturnedDependingOnTheCase(
|
public function nextIsCalledWhenNoRedirectIsResolved(callable $setUp): void
|
||||||
ServerRequestInterface $request,
|
{
|
||||||
string $expectedRedirectTo,
|
|
||||||
): void {
|
|
||||||
$this->redirectOptions->invalidShortUrl = 'invalidShortUrl';
|
|
||||||
$this->redirectOptions->regular404 = 'regular404';
|
|
||||||
$this->redirectOptions->baseUrl = 'baseUrl';
|
|
||||||
|
|
||||||
$expectedResp = new Response();
|
$expectedResp = new Response();
|
||||||
$buildResp = $this->helper->buildRedirectResponse($expectedRedirectTo)->willReturn($expectedResp);
|
|
||||||
|
|
||||||
$next = $this->prophesize(RequestHandlerInterface::class);
|
$setUp($this->domainService, $this->resolver);
|
||||||
$handle = $next->handle($request)->willReturn(new Response());
|
$handle = $this->next->handle($this->req)->willReturn($expectedResp);
|
||||||
|
|
||||||
$resp = $this->middleware->process($request, $next->reveal());
|
$result = $this->middleware->process($this->req, $this->next->reveal());
|
||||||
|
|
||||||
self::assertSame($expectedResp, $resp);
|
self::assertSame($expectedResp, $result);
|
||||||
$buildResp->shouldHaveBeenCalledOnce();
|
|
||||||
$handle->shouldNotHaveBeenCalled();
|
|
||||||
}
|
|
||||||
|
|
||||||
public function provideRedirects(): iterable
|
|
||||||
{
|
|
||||||
yield 'base URL with trailing slash' => [
|
|
||||||
$this->withNotFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri('/'))),
|
|
||||||
'baseUrl',
|
|
||||||
];
|
|
||||||
yield 'base URL without trailing slash' => [
|
|
||||||
$this->withNotFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri(''))),
|
|
||||||
'baseUrl',
|
|
||||||
];
|
|
||||||
yield 'regular 404' => [
|
|
||||||
$this->withNotFoundType(ServerRequestFactory::fromGlobals()->withUri(new Uri('/foo/bar'))),
|
|
||||||
'regular404',
|
|
||||||
];
|
|
||||||
yield 'invalid short URL' => [
|
|
||||||
$this->withNotFoundType(ServerRequestFactory::fromGlobals()
|
|
||||||
->withAttribute(
|
|
||||||
RouteResult::class,
|
|
||||||
RouteResult::fromRoute(
|
|
||||||
new Route(
|
|
||||||
'',
|
|
||||||
$this->prophesize(MiddlewareInterface::class)->reveal(),
|
|
||||||
['GET'],
|
|
||||||
RedirectAction::class,
|
|
||||||
),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
->withUri(new Uri('/abc123'))),
|
|
||||||
'invalidShortUrl',
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @test */
|
|
||||||
public function nextMiddlewareIsInvokedWhenNotRedirectNeedsToOccur(): void
|
|
||||||
{
|
|
||||||
$req = $this->withNotFoundType(ServerRequestFactory::fromGlobals());
|
|
||||||
$resp = new Response();
|
|
||||||
|
|
||||||
$buildResp = $this->helper->buildRedirectResponse(Argument::cetera());
|
|
||||||
|
|
||||||
$next = $this->prophesize(RequestHandlerInterface::class);
|
|
||||||
$handle = $next->handle($req)->willReturn($resp);
|
|
||||||
|
|
||||||
$result = $this->middleware->process($req, $next->reveal());
|
|
||||||
|
|
||||||
self::assertSame($resp, $result);
|
|
||||||
$buildResp->shouldNotHaveBeenCalled();
|
|
||||||
$handle->shouldHaveBeenCalledOnce();
|
$handle->shouldHaveBeenCalledOnce();
|
||||||
}
|
}
|
||||||
|
|
||||||
private function withNotFoundType(ServerRequestInterface $req): ServerRequestInterface
|
public function provideNonRedirectScenarios(): iterable
|
||||||
{
|
{
|
||||||
$type = NotFoundType::fromRequest($req, '');
|
yield 'no domain' => [function (ObjectProphecy $domainService, ObjectProphecy $resolver): void {
|
||||||
return $req->withAttribute(NotFoundType::class, $type);
|
$domainService->findByAuthority(Argument::cetera())
|
||||||
|
->willReturn(null)
|
||||||
|
->shouldBeCalledOnce();
|
||||||
|
$resolver->resolveRedirectResponse(Argument::cetera())
|
||||||
|
->willReturn(null)
|
||||||
|
->shouldBeCalledOnce();
|
||||||
|
}];
|
||||||
|
yield 'non-redirecting domain' => [function (ObjectProphecy $domainService, ObjectProphecy $resolver): void {
|
||||||
|
$domainService->findByAuthority(Argument::cetera())
|
||||||
|
->willReturn(new Domain(''))
|
||||||
|
->shouldBeCalledOnce();
|
||||||
|
$resolver->resolveRedirectResponse(Argument::cetera())
|
||||||
|
->willReturn(null)
|
||||||
|
->shouldBeCalledTimes(2);
|
||||||
|
}];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function globalRedirectIsUsedIfDomainRedirectIsNotFound(): void
|
||||||
|
{
|
||||||
|
$expectedResp = new Response();
|
||||||
|
|
||||||
|
$findDomain = $this->domainService->findByAuthority(Argument::cetera())->willReturn(null);
|
||||||
|
$resolveRedirect = $this->resolver->resolveRedirectResponse(
|
||||||
|
Argument::type(NotFoundType::class),
|
||||||
|
$this->redirectOptions,
|
||||||
|
)->willReturn($expectedResp);
|
||||||
|
|
||||||
|
$result = $this->middleware->process($this->req, $this->next->reveal());
|
||||||
|
|
||||||
|
self::assertSame($expectedResp, $result);
|
||||||
|
$findDomain->shouldHaveBeenCalledOnce();
|
||||||
|
$resolveRedirect->shouldHaveBeenCalledOnce();
|
||||||
|
$this->next->handle(Argument::cetera())->shouldNotHaveBeenCalled();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function domainRedirectIsUsedIfFound(): void
|
||||||
|
{
|
||||||
|
$expectedResp = new Response();
|
||||||
|
$domain = new Domain('');
|
||||||
|
|
||||||
|
$findDomain = $this->domainService->findByAuthority(Argument::cetera())->willReturn($domain);
|
||||||
|
$resolveRedirect = $this->resolver->resolveRedirectResponse(
|
||||||
|
Argument::type(NotFoundType::class),
|
||||||
|
$domain,
|
||||||
|
)->willReturn($expectedResp);
|
||||||
|
|
||||||
|
$result = $this->middleware->process($this->req, $this->next->reveal());
|
||||||
|
|
||||||
|
self::assertSame($expectedResp, $result);
|
||||||
|
$findDomain->shouldHaveBeenCalledOnce();
|
||||||
|
$resolveRedirect->shouldHaveBeenCalledOnce();
|
||||||
|
$this->next->handle(Argument::cetera())->shouldNotHaveBeenCalled();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user