Merge pull request #1501 from shlinkio/develop

Release 3.2.1
This commit is contained in:
Alejandro Celaya 2022-08-08 19:51:00 +02:00 committed by GitHub
commit 28b9cd02ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 231 additions and 126 deletions

View File

@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org). The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
## [3.2.1] - 2022-08-08
### Added
* *Nothing*
### Changed
* [#1495](https://github.com/shlinkio/shlink/issues/1495) Centralized how routes are configured to support multi-segment slugs.
* [#1497](https://github.com/shlinkio/shlink/issues/1497) Updated to latest shlink dependencies with support for PHP 8.1 only.
### Deprecated
* *Nothing*
### Removed
* *Nothing*
### Fixed
* [#1499](https://github.com/shlinkio/shlink/issues/1499) Fixed loading of config options as env vars, which was making all default configurations to be loaded unless env vars were explicitly provided.
## [3.2.0] - 2022-08-05 ## [3.2.0] - 2022-08-05
### Added ### Added
* [#854](https://github.com/shlinkio/shlink/issues/854) Added support for multi-segment custom slugs. * [#854](https://github.com/shlinkio/shlink/issues/854) Added support for multi-segment custom slugs.

View File

@ -43,12 +43,12 @@
"php-middleware/request-id": "^4.1", "php-middleware/request-id": "^4.1",
"pugx/shortid-php": "^1.0", "pugx/shortid-php": "^1.0",
"ramsey/uuid": "^4.3", "ramsey/uuid": "^4.3",
"shlinkio/shlink-common": "^4.5", "shlinkio/shlink-common": "^5.0",
"shlinkio/shlink-config": "^1.6", "shlinkio/shlink-config": "^2.0",
"shlinkio/shlink-event-dispatcher": "^2.4", "shlinkio/shlink-event-dispatcher": "^2.5",
"shlinkio/shlink-importer": "^3.0", "shlinkio/shlink-importer": "^4.0",
"shlinkio/shlink-installer": "^8.0", "shlinkio/shlink-installer": "^8.1",
"shlinkio/shlink-ip-geolocation": "^2.2", "shlinkio/shlink-ip-geolocation": "^3.0",
"symfony/console": "^6.1", "symfony/console": "^6.1",
"symfony/filesystem": "^6.1", "symfony/filesystem": "^6.1",
"symfony/lock": "^6.1", "symfony/lock": "^6.1",
@ -69,7 +69,7 @@
"phpunit/phpunit": "^9.5", "phpunit/phpunit": "^9.5",
"roave/security-advisories": "dev-master", "roave/security-advisories": "dev-master",
"shlinkio/php-coding-standard": "~2.3.0", "shlinkio/php-coding-standard": "~2.3.0",
"shlinkio/shlink-test-utils": "^3.0.1", "shlinkio/shlink-test-utils": "^3.1.0",
"symfony/var-dumper": "^6.1", "symfony/var-dumper": "^6.1",
"veewee/composer-run-parallel": "^1.1" "veewee/composer-run-parallel": "^1.1"
}, },

View File

@ -7,23 +7,19 @@ namespace Shlinkio\Shlink;
use Fig\Http\Message\RequestMethodInterface; use Fig\Http\Message\RequestMethodInterface;
use RKA\Middleware\IpAddress; use RKA\Middleware\IpAddress;
use Shlinkio\Shlink\Core\Action as CoreAction; use Shlinkio\Shlink\Core\Action as CoreAction;
use Shlinkio\Shlink\Core\Config\EnvVars;
use Shlinkio\Shlink\Rest\Action; use Shlinkio\Shlink\Rest\Action;
use Shlinkio\Shlink\Rest\ConfigProvider; use Shlinkio\Shlink\Rest\ConfigProvider;
use Shlinkio\Shlink\Rest\Middleware; use Shlinkio\Shlink\Rest\Middleware;
use Shlinkio\Shlink\Rest\Middleware\Mercure\NotConfiguredMercureErrorHandler; use Shlinkio\Shlink\Rest\Middleware\Mercure\NotConfiguredMercureErrorHandler;
use function sprintf;
// The order of the routes defined here matters. Changing it might cause path conflicts
return (static function (): array { return (static function (): array {
$contentNegotiationMiddleware = Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class; $contentNegotiationMiddleware = Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class;
$dropDomainMiddleware = Middleware\ShortUrl\DropDefaultDomainFromRequestMiddleware::class; $dropDomainMiddleware = Middleware\ShortUrl\DropDefaultDomainFromRequestMiddleware::class;
$overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class; $overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class;
$multiSegment = (bool) EnvVars::MULTI_SEGMENT_SLUGS_ENABLED->loadFromEnv(false);
return [ return [
// The order of the routes defined here matters. Changing it might cause path conflicts
'routes' => [ 'routes' => [
// Rest // Rest
...ConfigProvider::applyRoutesPrefix([ ...ConfigProvider::applyRoutesPrefix([
@ -64,7 +60,7 @@ return (static function (): array {
Action\Domain\DomainRedirectsAction::getRouteDef(), Action\Domain\DomainRedirectsAction::getRouteDef(),
Action\MercureInfoAction::getRouteDef([NotConfiguredMercureErrorHandler::class]), Action\MercureInfoAction::getRouteDef([NotConfiguredMercureErrorHandler::class]),
], $multiSegment), ]),
// Non-rest // Non-rest
[ [
@ -77,7 +73,7 @@ return (static function (): array {
], ],
[ [
'name' => CoreAction\PixelAction::class, 'name' => CoreAction\PixelAction::class,
'path' => sprintf('/{shortCode%s}/track', $multiSegment ? ':.+' : ''), 'path' => '/{shortCode}/track',
'middleware' => [ 'middleware' => [
IpAddress::class, IpAddress::class,
CoreAction\PixelAction::class, CoreAction\PixelAction::class,
@ -86,7 +82,7 @@ return (static function (): array {
], ],
[ [
'name' => CoreAction\QrCodeAction::class, 'name' => CoreAction\QrCodeAction::class,
'path' => sprintf('/{shortCode%s}/qr-code', $multiSegment ? ':.+' : ''), 'path' => '/{shortCode}/qr-code',
'middleware' => [ 'middleware' => [
CoreAction\QrCodeAction::class, CoreAction\QrCodeAction::class,
], ],
@ -94,7 +90,7 @@ return (static function (): array {
], ],
[ [
'name' => CoreAction\RedirectAction::class, 'name' => CoreAction\RedirectAction::class,
'path' => sprintf('/{shortCode%s}', $multiSegment ? ':.+' : ''), 'path' => '/{shortCode}',
'middleware' => [ 'middleware' => [
IpAddress::class, IpAddress::class,
CoreAction\RedirectAction::class, CoreAction\RedirectAction::class,

View File

@ -12,6 +12,7 @@ return [
'hostname' => sprintf('localhost:%s', $isSwoole ? '8080' : '8000'), 'hostname' => sprintf('localhost:%s', $isSwoole ? '8080' : '8000'),
], ],
'auto_resolve_titles' => true, 'auto_resolve_titles' => true,
// 'multi_segment_slugs_enabled' => true,
], ],
]; ];

View File

@ -21,7 +21,7 @@ $isTestEnv = env('APP_ENV') === 'test';
return (new ConfigAggregator\ConfigAggregator([ return (new ConfigAggregator\ConfigAggregator([
! $isTestEnv ! $isTestEnv
? new EnvVarLoaderProvider('config/params/generated_config.php', Core\Config\EnvVars::cases()) ? new EnvVarLoaderProvider('config/params/generated_config.php', Core\Config\EnvVars::values())
: new ConfigAggregator\ArrayProvider([]), : new ConfigAggregator\ArrayProvider([]),
Mezzio\ConfigProvider::class, Mezzio\ConfigProvider::class,
Mezzio\Router\ConfigProvider::class, Mezzio\Router\ConfigProvider::class,
@ -47,4 +47,5 @@ return (new ConfigAggregator\ConfigAggregator([
new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'), new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
], 'data/cache/app_config.php', [ ], 'data/cache/app_config.php', [
Core\Config\BasePathPrefixer::class, Core\Config\BasePathPrefixer::class,
Core\Config\MultiSegmentSlugProcessor::class,
]))->getMergedConfig(); ]))->getMergedConfig();

View File

@ -4,6 +4,7 @@ declare(strict_types=1);
namespace Shlinkio\Shlink\Core\Config; namespace Shlinkio\Shlink\Core\Config;
use function Functional\map;
use function Shlinkio\Shlink\Config\env; use function Shlinkio\Shlink\Config\env;
enum EnvVars: string enum EnvVars: string
@ -74,4 +75,13 @@ enum EnvVars: string
{ {
return $this->loadFromEnv() !== null; return $this->loadFromEnv() !== null;
} }
/**
* @return string[]
*/
public static function values(): array
{
static $values;
return $values ?? ($values = map(self::cases(), static fn (EnvVars $envVar) => $envVar->value));
}
} }

View File

@ -0,0 +1,30 @@
<?php
declare(strict_types=1);
namespace Shlinkio\Shlink\Core\Config;
use function Functional\map;
use function str_replace;
class MultiSegmentSlugProcessor
{
private const SINGLE_SHORT_CODE_PATTERN = '{shortCode}';
private const MULTI_SHORT_CODE_PATTERN = '{shortCode:.+}';
public function __invoke(array $config): array
{
$multiSegmentEnabled = $config['url_shortener']['multi_segment_slugs_enabled'] ?? false;
if (! $multiSegmentEnabled) {
return $config;
}
$config['routes'] = map($config['routes'] ?? [], static function (array $route): array {
['path' => $path] = $route;
$route['path'] = str_replace(self::SINGLE_SHORT_CODE_PATTERN, self::MULTI_SHORT_CODE_PATTERN, $path);
return $route;
});
return $config;
}
}

View File

@ -94,31 +94,31 @@ class ShortUrl extends AbstractEntity
): self { ): self {
$meta = [ $meta = [
ShortUrlInputFilter::VALIDATE_URL => false, ShortUrlInputFilter::VALIDATE_URL => false,
ShortUrlInputFilter::LONG_URL => $url->longUrl(), ShortUrlInputFilter::LONG_URL => $url->longUrl,
ShortUrlInputFilter::DOMAIN => $url->domain(), ShortUrlInputFilter::DOMAIN => $url->domain,
ShortUrlInputFilter::TAGS => $url->tags(), ShortUrlInputFilter::TAGS => $url->tags,
ShortUrlInputFilter::TITLE => $url->title(), ShortUrlInputFilter::TITLE => $url->title,
ShortUrlInputFilter::MAX_VISITS => $url->meta()->maxVisits(), ShortUrlInputFilter::MAX_VISITS => $url->meta->maxVisits,
]; ];
if ($importShortCode) { if ($importShortCode) {
$meta[ShortUrlInputFilter::CUSTOM_SLUG] = $url->shortCode(); $meta[ShortUrlInputFilter::CUSTOM_SLUG] = $url->shortCode;
} }
$instance = self::fromMeta(ShortUrlMeta::fromRawData($meta), $relationResolver); $instance = self::fromMeta(ShortUrlMeta::fromRawData($meta), $relationResolver);
$validSince = $url->meta()->validSince(); $validSince = $url->meta->validSince;
if ($validSince !== null) { if ($validSince !== null) {
$instance->validSince = Chronos::instance($validSince); $instance->validSince = Chronos::instance($validSince);
} }
$validUntil = $url->meta()->validUntil(); $validUntil = $url->meta->validUntil;
if ($validUntil !== null) { if ($validUntil !== null) {
$instance->validUntil = Chronos::instance($validUntil); $instance->validUntil = Chronos::instance($validUntil);
} }
$instance->importSource = $url->source(); $instance->importSource = $url->source->value;
$instance->importOriginalShortCode = $url->shortCode(); $instance->importOriginalShortCode = $url->shortCode;
$instance->dateCreated = Chronos::instance($url->createdAt()); $instance->dateCreated = Chronos::instance($url->createdAt);
return $instance; return $instance;
} }

View File

@ -45,12 +45,12 @@ class Visit extends AbstractEntity implements JsonSerializable
public static function fromImport(ShortUrl $shortUrl, ImportedShlinkVisit $importedVisit): self public static function fromImport(ShortUrl $shortUrl, ImportedShlinkVisit $importedVisit): self
{ {
$instance = new self($shortUrl, VisitType::IMPORTED); $instance = new self($shortUrl, VisitType::IMPORTED);
$instance->userAgent = $importedVisit->userAgent(); $instance->userAgent = $importedVisit->userAgent;
$instance->potentialBot = isCrawler($instance->userAgent); $instance->potentialBot = isCrawler($instance->userAgent);
$instance->referer = $importedVisit->referer(); $instance->referer = $importedVisit->referer;
$instance->date = Chronos::instance($importedVisit->date()); $instance->date = Chronos::instance($importedVisit->date);
$importedLocation = $importedVisit->location(); $importedLocation = $importedVisit->location;
$instance->visitLocation = $importedLocation !== null ? VisitLocation::fromImport($importedLocation) : null; $instance->visitLocation = $importedLocation !== null ? VisitLocation::fromImport($importedLocation) : null;
return $instance; return $instance;

View File

@ -28,13 +28,13 @@ class VisitLocation extends AbstractEntity implements JsonSerializable
{ {
$instance = new self(); $instance = new self();
$instance->countryCode = $location->countryCode(); $instance->countryCode = $location->countryCode;
$instance->countryName = $location->countryName(); $instance->countryName = $location->countryName;
$instance->regionName = $location->regionName(); $instance->regionName = $location->regionName;
$instance->cityName = $location->city(); $instance->cityName = $location->city;
$instance->latitude = $location->latitude(); $instance->latitude = $location->latitude;
$instance->longitude = $location->longitude(); $instance->longitude = $location->longitude;
$instance->timezone = $location->timeZone(); $instance->timezone = $location->timeZone;
$instance->computeIsEmpty(); $instance->computeIsEmpty();
return $instance; return $instance;
@ -44,13 +44,13 @@ class VisitLocation extends AbstractEntity implements JsonSerializable
{ {
$instance = new self(); $instance = new self();
$instance->countryCode = $location->countryCode(); $instance->countryCode = $location->countryCode;
$instance->countryName = $location->countryName(); $instance->countryName = $location->countryName;
$instance->regionName = $location->regionName(); $instance->regionName = $location->regionName;
$instance->cityName = $location->cityName(); $instance->cityName = $location->cityName;
$instance->latitude = $location->latitude(); $instance->latitude = $location->latitude;
$instance->longitude = $location->longitude(); $instance->longitude = $location->longitude;
$instance->timezone = $location->timeZone(); $instance->timezone = $location->timezone;
$instance->computeIsEmpty(); $instance->computeIsEmpty();
return $instance; return $instance;

View File

@ -38,6 +38,6 @@ class NonUniqueSlugException extends InvalidArgumentException implements Problem
public static function fromImport(ImportedShlinkUrl $importedUrl): self public static function fromImport(ImportedShlinkUrl $importedUrl): self
{ {
return self::fromSlug($importedUrl->shortCode(), $importedUrl->domain()); return self::fromSlug($importedUrl->shortCode, $importedUrl->domain);
} }
} }

View File

@ -14,7 +14,7 @@ use Shlinkio\Shlink\Core\Util\DoctrineBatchHelperInterface;
use Shlinkio\Shlink\Importer\ImportedLinksProcessorInterface; use Shlinkio\Shlink\Importer\ImportedLinksProcessorInterface;
use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl; use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl;
use Shlinkio\Shlink\Importer\Params\ImportParams; use Shlinkio\Shlink\Importer\Params\ImportParams;
use Shlinkio\Shlink\Importer\Sources\ImportSources; use Shlinkio\Shlink\Importer\Sources\ImportSource;
use Symfony\Component\Console\Style\OutputStyle; use Symfony\Component\Console\Style\OutputStyle;
use Symfony\Component\Console\Style\StyleInterface; use Symfony\Component\Console\Style\StyleInterface;
use Throwable; use Throwable;
@ -26,10 +26,10 @@ class ImportedLinksProcessor implements ImportedLinksProcessorInterface
private ShortUrlRepositoryInterface $shortUrlRepo; private ShortUrlRepositoryInterface $shortUrlRepo;
public function __construct( public function __construct(
private EntityManagerInterface $em, private readonly EntityManagerInterface $em,
private ShortUrlRelationResolverInterface $relationResolver, private readonly ShortUrlRelationResolverInterface $relationResolver,
private ShortCodeUniquenessHelperInterface $shortCodeHelper, private readonly ShortCodeUniquenessHelperInterface $shortCodeHelper,
private DoctrineBatchHelperInterface $batchHelper, private readonly DoctrineBatchHelperInterface $batchHelper,
) { ) {
$this->shortUrlRepo = $this->em->getRepository(ShortUrl::class); $this->shortUrlRepo = $this->em->getRepository(ShortUrl::class);
} }
@ -39,19 +39,19 @@ class ImportedLinksProcessor implements ImportedLinksProcessorInterface
*/ */
public function process(StyleInterface $io, iterable $shlinkUrls, ImportParams $params): void public function process(StyleInterface $io, iterable $shlinkUrls, ImportParams $params): void
{ {
$importShortCodes = $params->importShortCodes(); $importShortCodes = $params->importShortCodes;
$source = $params->source(); $source = $params->source;
$iterable = $this->batchHelper->wrapIterable($shlinkUrls, $source === ImportSources::SHLINK ? 10 : 100); $iterable = $this->batchHelper->wrapIterable($shlinkUrls, $source === ImportSource::SHLINK ? 10 : 100);
/** @var ImportedShlinkUrl $importedUrl */ /** @var ImportedShlinkUrl $importedUrl */
foreach ($iterable as $importedUrl) { foreach ($iterable as $importedUrl) {
$skipOnShortCodeConflict = static fn (): bool => $io->choice(sprintf( $skipOnShortCodeConflict = static fn (): bool => $io->choice(sprintf(
'Failed to import URL "%s" because its short-code "%s" is already in use. Do you want to generate ' 'Failed to import URL "%s" because its short-code "%s" is already in use. Do you want to generate '
. 'a new one or skip it?', . 'a new one or skip it?',
$importedUrl->longUrl(), $importedUrl->longUrl,
$importedUrl->shortCode(), $importedUrl->shortCode,
), ['Generate new short-code', 'Skip'], 1) === 'Skip'; ), ['Generate new short-code', 'Skip'], 1) === 'Skip';
$longUrl = $importedUrl->longUrl(); $longUrl = $importedUrl->longUrl;
try { try {
$shortUrlImporting = $this->resolveShortUrl($importedUrl, $importShortCodes, $skipOnShortCodeConflict); $shortUrlImporting = $this->resolveShortUrl($importedUrl, $importShortCodes, $skipOnShortCodeConflict);
@ -68,7 +68,7 @@ class ImportedLinksProcessor implements ImportedLinksProcessorInterface
continue; continue;
} }
$resultMessage = $shortUrlImporting->importVisits($importedUrl->visits(), $this->em); $resultMessage = $shortUrlImporting->importVisits($importedUrl->visits, $this->em);
$io->text(sprintf('%s: %s', $longUrl, $resultMessage)); $io->text(sprintf('%s: %s', $longUrl, $resultMessage));
} }
} }

View File

@ -38,7 +38,7 @@ final class ShortUrlImporting
$importedVisits = 0; $importedVisits = 0;
foreach ($visits as $importedVisit) { foreach ($visits as $importedVisit) {
// Skip visits which are older than the most recent already imported visit's date // Skip visits which are older than the most recent already imported visit's date
if ($mostRecentImportedDate?->gte(Chronos::instance($importedVisit->date()))) { if ($mostRecentImportedDate?->gte(Chronos::instance($importedVisit->date))) {
continue; continue;
} }

View File

@ -84,13 +84,13 @@ class ShortUrlRepository extends EntitySpecificationRepository implements ShortU
->where('1=1'); ->where('1=1');
$dateRange = $filtering->dateRange(); $dateRange = $filtering->dateRange();
if ($dateRange?->startDate() !== null) { if ($dateRange?->startDate !== null) {
$qb->andWhere($qb->expr()->gte('s.dateCreated', ':startDate')); $qb->andWhere($qb->expr()->gte('s.dateCreated', ':startDate'));
$qb->setParameter('startDate', $dateRange->startDate(), ChronosDateTimeType::CHRONOS_DATETIME); $qb->setParameter('startDate', $dateRange->startDate, ChronosDateTimeType::CHRONOS_DATETIME);
} }
if ($dateRange?->endDate() !== null) { if ($dateRange?->endDate !== null) {
$qb->andWhere($qb->expr()->lte('s.dateCreated', ':endDate')); $qb->andWhere($qb->expr()->lte('s.dateCreated', ':endDate'));
$qb->setParameter('endDate', $dateRange->endDate(), ChronosDateTimeType::CHRONOS_DATETIME); $qb->setParameter('endDate', $dateRange->endDate, ChronosDateTimeType::CHRONOS_DATETIME);
} }
$searchTerm = $filtering->searchTerm(); $searchTerm = $filtering->searchTerm();
@ -284,12 +284,12 @@ class ShortUrlRepository extends EntitySpecificationRepository implements ShortU
{ {
$qb = $this->createQueryBuilder('s'); $qb = $this->createQueryBuilder('s');
$qb->andWhere($qb->expr()->eq('s.importOriginalShortCode', ':shortCode')) $qb->andWhere($qb->expr()->eq('s.importOriginalShortCode', ':shortCode'))
->setParameter('shortCode', $url->shortCode()) ->setParameter('shortCode', $url->shortCode)
->andWhere($qb->expr()->eq('s.importSource', ':importSource')) ->andWhere($qb->expr()->eq('s.importSource', ':importSource'))
->setParameter('importSource', $url->source()) ->setParameter('importSource', $url->source->value)
->setMaxResults(1); ->setMaxResults(1);
$this->whereDomainIs($qb, $url->domain()); $this->whereDomainIs($qb, $url->domain);
return $qb->getQuery()->getOneOrNullResult(); return $qb->getQuery()->getOneOrNullResult();
} }

View File

@ -245,11 +245,11 @@ class VisitRepository extends EntitySpecificationRepository implements VisitRepo
{ {
$conn = $this->getEntityManager()->getConnection(); $conn = $this->getEntityManager()->getConnection();
if ($dateRange?->startDate() !== null) { if ($dateRange?->startDate !== null) {
$qb->andWhere($qb->expr()->gte('v.date', $conn->quote($dateRange->startDate()->toDateTimeString()))); $qb->andWhere($qb->expr()->gte('v.date', $conn->quote($dateRange->startDate->toDateTimeString())));
} }
if ($dateRange?->endDate() !== null) { if ($dateRange?->endDate !== null) {
$qb->andWhere($qb->expr()->lte('v.date', $conn->quote($dateRange->endDate()->toDateTimeString()))); $qb->andWhere($qb->expr()->lte('v.date', $conn->quote($dateRange->endDate->toDateTimeString())));
} }
} }

View File

@ -20,12 +20,12 @@ class InDateRange extends BaseSpecification
{ {
$criteria = []; $criteria = [];
if ($this->dateRange?->startDate() !== null) { if ($this->dateRange?->startDate !== null) {
$criteria[] = Spec::gte($this->field, $this->dateRange->startDate()->toDateTimeString()); $criteria[] = Spec::gte($this->field, $this->dateRange->startDate->toDateTimeString());
} }
if ($this->dateRange?->endDate() !== null) { if ($this->dateRange?->endDate !== null) {
$criteria[] = Spec::lte($this->field, $this->dateRange->endDate()->toDateTimeString()); $criteria[] = Spec::lte($this->field, $this->dateRange->endDate->toDateTimeString());
} }
return Spec::andX(...$criteria); return Spec::andX(...$criteria);

View File

@ -21,6 +21,7 @@ use Shlinkio\Shlink\Core\ShortUrl\Persistence\ShortUrlsCountFiltering;
use Shlinkio\Shlink\Core\ShortUrl\Persistence\ShortUrlsListFiltering; use Shlinkio\Shlink\Core\ShortUrl\Persistence\ShortUrlsListFiltering;
use Shlinkio\Shlink\Core\ShortUrl\Resolver\PersistenceShortUrlRelationResolver; use Shlinkio\Shlink\Core\ShortUrl\Resolver\PersistenceShortUrlRelationResolver;
use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl; use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl;
use Shlinkio\Shlink\Importer\Sources\ImportSource;
use Shlinkio\Shlink\Rest\ApiKey\Model\ApiKeyMeta; use Shlinkio\Shlink\Rest\ApiKey\Model\ApiKeyMeta;
use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition; use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
use Shlinkio\Shlink\Rest\Entity\ApiKey; use Shlinkio\Shlink\Rest\Entity\ApiKey;
@ -601,7 +602,7 @@ class ShortUrlRepositoryTest extends DatabaseTestCase
public function importedShortUrlsAreFoundWhenExpected(): void public function importedShortUrlsAreFoundWhenExpected(): void
{ {
$buildImported = static fn (string $shortCode, ?String $domain = null) => $buildImported = static fn (string $shortCode, ?String $domain = null) =>
new ImportedShlinkUrl('', 'foo', [], Chronos::now(), $domain, $shortCode, null); new ImportedShlinkUrl(ImportSource::BITLY, 'foo', [], Chronos::now(), $domain, $shortCode, null);
$shortUrlWithoutDomain = ShortUrl::fromImport($buildImported('my-cool-slug'), true); $shortUrlWithoutDomain = ShortUrl::fromImport($buildImported('my-cool-slug'), true);
$this->getEntityManager()->persist($shortUrlWithoutDomain); $this->getEntityManager()->persist($shortUrlWithoutDomain);

View File

@ -7,6 +7,7 @@ namespace ShlinkioTest\Shlink\Core\Config;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use Shlinkio\Shlink\Core\Config\EnvVars; use Shlinkio\Shlink\Core\Config\EnvVars;
use function Functional\map;
use function putenv; use function putenv;
class EnvVarsTest extends TestCase class EnvVarsTest extends TestCase
@ -58,4 +59,11 @@ class EnvVarsTest extends TestCase
yield 'DB_DRIVER without default' => [EnvVars::DB_DRIVER, null, null]; yield 'DB_DRIVER without default' => [EnvVars::DB_DRIVER, null, null];
yield 'DB_DRIVER with default' => [EnvVars::DB_DRIVER, 'foobar', 'foobar']; yield 'DB_DRIVER with default' => [EnvVars::DB_DRIVER, 'foobar', 'foobar'];
} }
/** @test */
public function allValuesCanBeListed(): void
{
$expected = map(EnvVars::cases(), static fn (EnvVars $envVar) => $envVar->value);
self::assertEquals(EnvVars::values(), $expected);
}
} }

View File

@ -0,0 +1,60 @@
<?php
declare(strict_types=1);
namespace ShlinkioTest\Shlink\Core\Config;
use PHPUnit\Framework\TestCase;
use Shlinkio\Shlink\Core\Config\MultiSegmentSlugProcessor;
class MultiSegmentSlugProcessorTest extends TestCase
{
private MultiSegmentSlugProcessor $processor;
protected function setUp(): void
{
$this->processor = new MultiSegmentSlugProcessor();
}
/**
* @test
* @dataProvider provideConfigs
*/
public function parsesRoutesAsExpected(array $config, array $expectedRoutes): void
{
self::assertEquals($expectedRoutes, ($this->processor)($config)['routes'] ?? []);
}
public function provideConfigs(): iterable
{
yield [[], []];
yield [['url_shortener' => []], []];
yield [['url_shortener' => ['multi_segment_slugs_enabled' => false]], []];
yield [
[
'url_shortener' => ['multi_segment_slugs_enabled' => false],
'routes' => $routes = [
['path' => '/foo'],
['path' => '/bar/{shortCode}'],
['path' => '/baz/{shortCode}/foo'],
],
],
$routes,
];
yield [
[
'url_shortener' => ['multi_segment_slugs_enabled' => true],
'routes' => [
['path' => '/foo'],
['path' => '/bar/{shortCode}'],
['path' => '/baz/{shortCode}/foo'],
],
],
[
['path' => '/foo'],
['path' => '/bar/{shortCode:.+}'],
['path' => '/baz/{shortCode:.+}/foo'],
],
];
}
}

View File

@ -11,6 +11,7 @@ use Shlinkio\Shlink\Core\Exception\ShortCodeCannotBeRegeneratedException;
use Shlinkio\Shlink\Core\Model\ShortUrlMeta; use Shlinkio\Shlink\Core\Model\ShortUrlMeta;
use Shlinkio\Shlink\Core\Validation\ShortUrlInputFilter; use Shlinkio\Shlink\Core\Validation\ShortUrlInputFilter;
use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl; use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl;
use Shlinkio\Shlink\Importer\Sources\ImportSource;
use function Functional\map; use function Functional\map;
use function range; use function range;
@ -63,9 +64,10 @@ class ShortUrlTest extends TestCase
public function provideValidShortUrls(): iterable public function provideValidShortUrls(): iterable
{ {
yield 'no custom slug' => [ShortUrl::createEmpty()]; yield 'no custom slug' => [ShortUrl::createEmpty()];
yield 'imported with custom slug' => [ yield 'imported with custom slug' => [ShortUrl::fromImport(
ShortUrl::fromImport(new ImportedShlinkUrl('', '', [], Chronos::now(), null, 'custom-slug', null), true), new ImportedShlinkUrl(ImportSource::BITLY, '', [], Chronos::now(), null, 'custom-slug', null),
]; true,
)];
} }
/** /**

View File

@ -22,7 +22,7 @@ use Shlinkio\Shlink\Core\Util\DoctrineBatchHelperInterface;
use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl; use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl;
use Shlinkio\Shlink\Importer\Model\ImportedShlinkVisit; use Shlinkio\Shlink\Importer\Model\ImportedShlinkVisit;
use Shlinkio\Shlink\Importer\Params\ImportParams; use Shlinkio\Shlink\Importer\Params\ImportParams;
use Shlinkio\Shlink\Importer\Sources\ImportSources; use Shlinkio\Shlink\Importer\Sources\ImportSource;
use Symfony\Component\Console\Style\StyleInterface; use Symfony\Component\Console\Style\StyleInterface;
use function count; use function count;
@ -64,9 +64,9 @@ class ImportedLinksProcessorTest extends TestCase
public function newUrlsWithNoErrorsAreAllPersisted(): void public function newUrlsWithNoErrorsAreAllPersisted(): void
{ {
$urls = [ $urls = [
new ImportedShlinkUrl('', 'foo', [], Chronos::now(), null, 'foo', null), new ImportedShlinkUrl(ImportSource::BITLY, 'foo', [], Chronos::now(), null, 'foo', null),
new ImportedShlinkUrl('', 'bar', [], Chronos::now(), null, 'bar', 'foo'), new ImportedShlinkUrl(ImportSource::BITLY, 'bar', [], Chronos::now(), null, 'bar', 'foo'),
new ImportedShlinkUrl('', 'baz', [], Chronos::now(), null, 'baz', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz', [], Chronos::now(), null, 'baz', null),
]; ];
$expectedCalls = count($urls); $expectedCalls = count($urls);
@ -86,9 +86,9 @@ class ImportedLinksProcessorTest extends TestCase
public function newUrlsWithErrorsAreSkipped(): void public function newUrlsWithErrorsAreSkipped(): void
{ {
$urls = [ $urls = [
new ImportedShlinkUrl('', 'foo', [], Chronos::now(), null, 'foo', null), new ImportedShlinkUrl(ImportSource::BITLY, 'foo', [], Chronos::now(), null, 'foo', null),
new ImportedShlinkUrl('', 'bar', [], Chronos::now(), null, 'bar', 'foo'), new ImportedShlinkUrl(ImportSource::BITLY, 'bar', [], Chronos::now(), null, 'bar', 'foo'),
new ImportedShlinkUrl('', 'baz', [], Chronos::now(), null, 'baz', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz', [], Chronos::now(), null, 'baz', null),
]; ];
$importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->willReturn(null); $importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->willReturn(null);
@ -117,11 +117,11 @@ class ImportedLinksProcessorTest extends TestCase
public function alreadyImportedUrlsAreSkipped(): void public function alreadyImportedUrlsAreSkipped(): void
{ {
$urls = [ $urls = [
new ImportedShlinkUrl('', 'foo', [], Chronos::now(), null, 'foo', null), new ImportedShlinkUrl(ImportSource::BITLY, 'foo', [], Chronos::now(), null, 'foo', null),
new ImportedShlinkUrl('', 'bar', [], Chronos::now(), null, 'bar', null), new ImportedShlinkUrl(ImportSource::BITLY, 'bar', [], Chronos::now(), null, 'bar', null),
new ImportedShlinkUrl('', 'baz', [], Chronos::now(), null, 'baz', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz', [], Chronos::now(), null, 'baz', null),
new ImportedShlinkUrl('', 'baz2', [], Chronos::now(), null, 'baz2', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz2', [], Chronos::now(), null, 'baz2', null),
new ImportedShlinkUrl('', 'baz3', [], Chronos::now(), null, 'baz3', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz3', [], Chronos::now(), null, 'baz3', null),
]; ];
$importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->will( $importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->will(
@ -129,7 +129,7 @@ class ImportedLinksProcessorTest extends TestCase
/** @var ImportedShlinkUrl $url */ /** @var ImportedShlinkUrl $url */
[$url] = $args; [$url] = $args;
return contains(['foo', 'baz2', 'baz3'], $url->longUrl()) ? ShortUrl::fromImport($url, true) : null; return contains(['foo', 'baz2', 'baz3'], $url->longUrl) ? ShortUrl::fromImport($url, true) : null;
}, },
); );
$ensureUniqueness = $this->shortCodeHelper->ensureShortCodeUniqueness(Argument::cetera())->willReturn(true); $ensureUniqueness = $this->shortCodeHelper->ensureShortCodeUniqueness(Argument::cetera())->willReturn(true);
@ -148,11 +148,11 @@ class ImportedLinksProcessorTest extends TestCase
public function nonUniqueShortCodesAreAskedToUser(): void public function nonUniqueShortCodesAreAskedToUser(): void
{ {
$urls = [ $urls = [
new ImportedShlinkUrl('', 'foo', [], Chronos::now(), null, 'foo', null), new ImportedShlinkUrl(ImportSource::BITLY, 'foo', [], Chronos::now(), null, 'foo', null),
new ImportedShlinkUrl('', 'bar', [], Chronos::now(), null, 'bar', null), new ImportedShlinkUrl(ImportSource::BITLY, 'bar', [], Chronos::now(), null, 'bar', null),
new ImportedShlinkUrl('', 'baz', [], Chronos::now(), null, 'baz', 'foo'), new ImportedShlinkUrl(ImportSource::BITLY, 'baz', [], Chronos::now(), null, 'baz', 'foo'),
new ImportedShlinkUrl('', 'baz2', [], Chronos::now(), null, 'baz2', null), new ImportedShlinkUrl(ImportSource::BITLY, 'baz2', [], Chronos::now(), null, 'baz2', null),
new ImportedShlinkUrl('', 'baz3', [], Chronos::now(), null, 'baz3', 'bar'), new ImportedShlinkUrl(ImportSource::BITLY, 'baz3', [], Chronos::now(), null, 'baz3', 'bar'),
]; ];
$importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->willReturn(null); $importedUrlExists = $this->repo->findOneByImportedUrl(Argument::cetera())->willReturn(null);
@ -210,7 +210,8 @@ class ImportedLinksProcessorTest extends TestCase
public function provideUrlsWithVisits(): iterable public function provideUrlsWithVisits(): iterable
{ {
$now = Chronos::now(); $now = Chronos::now();
$createImportedUrl = fn (array $visits) => new ImportedShlinkUrl('', 's', [], $now, null, 's', null, $visits); $createImportedUrl = static fn (array $visits) =>
new ImportedShlinkUrl(ImportSource::BITLY, 's', [], $now, null, 's', null, $visits);
yield 'new short URL' => [$createImportedUrl([ yield 'new short URL' => [$createImportedUrl([
new ImportedShlinkVisit('', '', $now, null), new ImportedShlinkVisit('', '', $now, null),
@ -248,9 +249,6 @@ class ImportedLinksProcessorTest extends TestCase
private function buildParams(): ImportParams private function buildParams(): ImportParams
{ {
return ImportParams::fromSourceAndCallableMap( return ImportSource::BITLY->toParamsWithCallableMap(['import_short_codes' => static fn () => true]);
ImportSources::BITLY,
['import_short_codes' => static fn () => true],
);
} }
} }

View File

@ -8,7 +8,6 @@ use function Functional\first;
use function Functional\map; use function Functional\map;
use function Shlinkio\Shlink\Config\loadConfigFromGlob; use function Shlinkio\Shlink\Config\loadConfigFromGlob;
use function sprintf; use function sprintf;
use function str_replace;
class ConfigProvider class ConfigProvider
{ {
@ -21,16 +20,12 @@ class ConfigProvider
return loadConfigFromGlob(__DIR__ . '/../config/{,*.}config.php'); return loadConfigFromGlob(__DIR__ . '/../config/{,*.}config.php');
} }
public static function applyRoutesPrefix(array $routes, bool $multiSegmentEnabled): array public static function applyRoutesPrefix(array $routes): array
{ {
$healthRoute = self::buildUnversionedHealthRouteFromExistingRoutes($routes); $healthRoute = self::buildUnversionedHealthRouteFromExistingRoutes($routes);
$prefixedRoutes = map($routes, static function (array $route) use ($multiSegmentEnabled) { $prefixedRoutes = map($routes, static function (array $route) {
['path' => $path] = $route; ['path' => $path] = $route;
if ($multiSegmentEnabled) {
$path = str_replace('{shortCode}', '{shortCode:.+}', $path);
}
$route['path'] = sprintf('%s%s', self::ROUTES_PREFIX, $path); $route['path'] = sprintf('%s%s', self::ROUTES_PREFIX, $path);
return $route; return $route;
}); });

View File

@ -33,9 +33,9 @@ class ConfigProviderTest extends TestCase
* @test * @test
* @dataProvider provideRoutesConfig * @dataProvider provideRoutesConfig
*/ */
public function routesAreProperlyPrefixed(array $routes, bool $multiSegmentEnabled, array $expected): void public function routesAreProperlyPrefixed(array $routes, array $expected): void
{ {
self::assertEquals($expected, ConfigProvider::applyRoutesPrefix($routes, $multiSegmentEnabled)); self::assertEquals($expected, ConfigProvider::applyRoutesPrefix($routes));
} }
public function provideRoutesConfig(): iterable public function provideRoutesConfig(): iterable
@ -47,7 +47,6 @@ class ConfigProviderTest extends TestCase
['path' => '/baz/foo'], ['path' => '/baz/foo'],
['path' => '/health'], ['path' => '/health'],
], ],
false,
[ [
['path' => '/rest/v{version:1|2}/foo'], ['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar'], ['path' => '/rest/v{version:1|2}/bar'],
@ -62,25 +61,11 @@ class ConfigProviderTest extends TestCase
['path' => '/bar'], ['path' => '/bar'],
['path' => '/baz/foo'], ['path' => '/baz/foo'],
], ],
false,
[ [
['path' => '/rest/v{version:1|2}/foo'], ['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar'], ['path' => '/rest/v{version:1|2}/bar'],
['path' => '/rest/v{version:1|2}/baz/foo'], ['path' => '/rest/v{version:1|2}/baz/foo'],
], ],
]; ];
yield 'multi-segment enabled' => [
[
['path' => '/foo'],
['path' => '/bar/{shortCode}'],
['path' => '/baz/{shortCode}/foo'],
],
true,
[
['path' => '/rest/v{version:1|2}/foo'],
['path' => '/rest/v{version:1|2}/bar/{shortCode:.+}'],
['path' => '/rest/v{version:1|2}/baz/{shortCode:.+}/foo'],
],
];
} }
} }