Merge pull request #2168 from acelaya-forks/feature/update-common

Update to latest shlink-common and remove deprecation references
shlinkio · Jul 29, 2024 · c10f0db · c10f0db
2 parents 6b0b528 + 037cd8a
commit c10f0db
Show file tree

Hide file tree

Showing 72 changed files with 213 additions and 136 deletions.
diff --git a/composer.json b/composer.json
@@ -44,7 +44,7 @@
         "pagerfanta/core": "^3.8",
         "ramsey/uuid": "^4.7",
         "shlinkio/doctrine-specification": "^2.1.1",
-        "shlinkio/shlink-common": "^6.1",
+        "shlinkio/shlink-common": "dev-main#144e5c1 as 6.2",
         "shlinkio/shlink-config": "^3.0",
         "shlinkio/shlink-event-dispatcher": "^4.1",
         "shlinkio/shlink-importer": "^5.3.2",

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -77,7 +77,7 @@ services:
 
     shlink_db_postgres:
         container_name: shlink_db_postgres
-        image: postgres:12.2-alpine
+        image: postgres:16.3-alpine
         ports:
             - "5434:5432"
         volumes:

diff --git a/module/CLI/src/Command/Domain/GetDomainVisitsCommand.php b/module/CLI/src/Command/Domain/GetDomainVisitsCommand.php
@@ -33,6 +33,9 @@ protected function configure(): void
             ->addArgument('domain', InputArgument::REQUIRED, 'The domain which visits we want to get.');
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator
     {
         $domain = $input->getArgument('domain');

diff --git a/module/CLI/src/Command/ShortUrl/GetShortUrlVisitsCommand.php b/module/CLI/src/Command/ShortUrl/GetShortUrlVisitsCommand.php
@@ -46,6 +46,9 @@ protected function interact(InputInterface $input, OutputInterface $output): voi
         }
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator
     {
         $identifier = $this->shortUrlIdentifierInput->toShortUrlIdentifier($input);

diff --git a/module/CLI/src/Command/ShortUrl/ListShortUrlsCommand.php b/module/CLI/src/Command/ShortUrl/ListShortUrlsCommand.php
@@ -9,14 +9,14 @@
 use Shlinkio\Shlink\CLI\Util\ExitCode;
 use Shlinkio\Shlink\CLI\Util\ShlinkTable;
 use Shlinkio\Shlink\Common\Paginator\Paginator;
-use Shlinkio\Shlink\Common\Paginator\Util\PagerfantaUtilsTrait;
-use Shlinkio\Shlink\Common\Rest\DataTransformerInterface;
+use Shlinkio\Shlink\Common\Paginator\Util\PagerfantaUtils;
 use Shlinkio\Shlink\Core\ShortUrl\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlsParams;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlWithVisitsSummary;
 use Shlinkio\Shlink\Core\ShortUrl\Model\TagsMode;
 use Shlinkio\Shlink\Core\ShortUrl\Model\Validation\ShortUrlsParamsInputFilter;
 use Shlinkio\Shlink\Core\ShortUrl\ShortUrlListServiceInterface;
+use Shlinkio\Shlink\Core\ShortUrl\Transformer\ShortUrlDataTransformerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -32,16 +32,14 @@
 
 class ListShortUrlsCommand extends Command
 {
-    use PagerfantaUtilsTrait;
-
     public const NAME = 'short-url:list';
 
     private readonly StartDateOption $startDateOption;
     private readonly EndDateOption $endDateOption;
 
     public function __construct(
         private readonly ShortUrlListServiceInterface $shortUrlService,
-        private readonly DataTransformerInterface $transformer,
+        private readonly ShortUrlDataTransformerInterface $transformer,
     ) {
         parent::__construct();
         $this->startDateOption = new StartDateOption($this, 'short URLs');
@@ -179,6 +177,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     /**
      * @param array<string, callable(array $serializedShortUrl, ShortUrl $shortUrl): ?string> $columnsMap
+     * @return Paginator<ShortUrlWithVisitsSummary>
      */
     private function renderPage(
         OutputInterface $output,
@@ -196,7 +195,7 @@ private function renderPage(
         ShlinkTable::default($output)->render(
             array_keys($columnsMap),
             $rows,
-            $all ? null : $this->formatCurrentPageMessage($shortUrls, 'Page %s of %s'),
+            $all ? null : PagerfantaUtils::formatCurrentPageMessage($shortUrls, 'Page %s of %s'),
         );
 
         return $shortUrls;

diff --git a/module/CLI/src/Command/Tag/GetTagVisitsCommand.php b/module/CLI/src/Command/Tag/GetTagVisitsCommand.php
@@ -33,6 +33,9 @@ protected function configure(): void
             ->addArgument('tag', InputArgument::REQUIRED, 'The tag which visits we want to get.');
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator
     {
         $tag = $input->getArgument('tag');

diff --git a/module/CLI/src/Command/Visit/AbstractVisitsListCommand.php b/module/CLI/src/Command/Visit/AbstractVisitsListCommand.php
@@ -46,6 +46,9 @@ final protected function execute(InputInterface $input, OutputInterface $output)
         return ExitCode::EXIT_SUCCESS;
     }
 
+    /**
+     * @param Paginator<Visit> $paginator
+     */
     private function resolveRowsAndHeaders(Paginator $paginator): array
     {
         $extraKeys = [];
@@ -74,6 +77,9 @@ private function resolveRowsAndHeaders(Paginator $paginator): array
         ];
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     abstract protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator;
 
     /**

diff --git a/module/CLI/src/Command/Visit/GetNonOrphanVisitsCommand.php b/module/CLI/src/Command/Visit/GetNonOrphanVisitsCommand.php
@@ -30,6 +30,9 @@ protected function configure(): void
             ->setDescription('Returns the list of non-orphan visits.');
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator
     {
         return $this->visitsHelper->nonOrphanVisits(new VisitsParams($dateRange));

diff --git a/module/CLI/src/Command/Visit/GetOrphanVisitsCommand.php b/module/CLI/src/Command/Visit/GetOrphanVisitsCommand.php
@@ -30,6 +30,9 @@ enumToString(OrphanVisitType::class),
             ));
     }
 
+    /**
+     * @return Paginator<Visit>
+     */
     protected function getVisitsPaginator(InputInterface $input, DateRange $dateRange): Paginator
     {
         $rawType = $input->getOption('type');

diff --git a/module/CLI/test/Command/Db/CreateDatabaseCommandTest.php b/module/CLI/test/Command/Db/CreateDatabaseCommandTest.php
@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Driver;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Platforms\SQLitePlatform;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -31,6 +32,7 @@ class CreateDatabaseCommandTest extends TestCase
     private MockObject & ProcessRunnerInterface $processHelper;
     private MockObject & Connection $regularConn;
     private MockObject & ClassMetadataFactory $metadataFactory;
+    /** @var MockObject&AbstractSchemaManager<SQLitePlatform> */
     private MockObject & AbstractSchemaManager $schemaManager;
     private MockObject & Driver $driver;
 

diff --git a/module/Core/src/Domain/Repository/DomainRepository.php b/module/Core/src/Domain/Repository/DomainRepository.php
@@ -14,6 +14,7 @@
 use Shlinkio\Shlink\Rest\ApiKey\Role;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
+/** @extends EntitySpecificationRepository<Domain> */
 class DomainRepository extends EntitySpecificationRepository implements DomainRepositoryInterface
 {
     /**

diff --git a/module/Core/src/Domain/Repository/DomainRepositoryInterface.php b/module/Core/src/Domain/Repository/DomainRepositoryInterface.php
@@ -9,6 +9,7 @@
 use Shlinkio\Shlink\Core\Domain\Entity\Domain;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
+/** @extends ObjectRepository<Domain> */
 interface DomainRepositoryInterface extends ObjectRepository, EntitySpecificationRepositoryInterface
 {
     /**

diff --git a/module/Core/src/Domain/Validation/DomainRedirectsInputFilter.php b/module/Core/src/Domain/Validation/DomainRedirectsInputFilter.php
@@ -8,6 +8,7 @@
 use Shlinkio\Shlink\Common\Validation\HostAndPortValidator;
 use Shlinkio\Shlink\Common\Validation\InputFactory;
 
+/** @extends InputFilter<mixed> */
 class DomainRedirectsInputFilter extends InputFilter
 {
     public const DOMAIN = 'domain';

diff --git a/module/Core/src/EventDispatcher/PublishingUpdatesGenerator.php b/module/Core/src/EventDispatcher/PublishingUpdatesGenerator.php
@@ -4,21 +4,21 @@
 
 namespace Shlinkio\Shlink\Core\EventDispatcher;
 
-use Shlinkio\Shlink\Common\Rest\DataTransformerInterface;
 use Shlinkio\Shlink\Common\UpdatePublishing\Update;
 use Shlinkio\Shlink\Core\ShortUrl\Entity\ShortUrl;
+use Shlinkio\Shlink\Core\ShortUrl\Transformer\ShortUrlDataTransformerInterface;
 use Shlinkio\Shlink\Core\Visit\Entity\Visit;
 
 final readonly class PublishingUpdatesGenerator implements PublishingUpdatesGeneratorInterface
 {
-    public function __construct(private DataTransformerInterface $shortUrlTransformer)
+    public function __construct(private ShortUrlDataTransformerInterface $shortUrlTransformer)
     {
     }
 
     public function newVisitUpdate(Visit $visit): Update
     {
         return Update::forTopicAndPayload(Topic::NEW_VISIT->value, [
-            'shortUrl' => $this->shortUrlTransformer->transform($visit->shortUrl),
+            'shortUrl' => $this->transformShortUrl($visit->shortUrl),
             'visit' => $visit->jsonSerialize(),
         ]);
     }
@@ -36,7 +36,7 @@ public function newShortUrlVisitUpdate(Visit $visit): Update
         $topic = Topic::newShortUrlVisit($shortUrl?->getShortCode());
 
         return Update::forTopicAndPayload($topic, [
-            'shortUrl' => $this->shortUrlTransformer->transform($shortUrl),
+            'shortUrl' => $this->transformShortUrl($shortUrl),
             'visit' => $visit->jsonSerialize(),
         ]);
     }
@@ -47,4 +47,9 @@ public function newShortUrlUpdate(ShortUrl $shortUrl): Update
             'shortUrl' => $this->shortUrlTransformer->transform($shortUrl),
         ]);
     }
+
+    private function transformShortUrl(?ShortUrl $shortUrl): array
+    {
+        return $shortUrl === null ? [] : $this->shortUrlTransformer->transform($shortUrl);
+    }
 }
diff --git a/module/Core/src/Exception/ValidationException.php b/module/Core/src/Exception/ValidationException.php
@@ -26,6 +26,9 @@ class ValidationException extends InvalidArgumentException implements ProblemDet
 
     private array $invalidElements;
 
+    /**
+     * @param InputFilterInterface<mixed> $inputFilter
+     */
     public static function fromInputFilter(InputFilterInterface $inputFilter, ?Throwable $prev = null): self
     {
         return static::fromArray($inputFilter->getMessages(), $prev);

diff --git a/module/Core/src/Paginator/Adapter/AbstractCacheableCountPaginatorAdapter.php b/module/Core/src/Paginator/Adapter/AbstractCacheableCountPaginatorAdapter.php
@@ -6,6 +6,10 @@
 
 use Pagerfanta\Adapter\AdapterInterface;
 
+/**
+ * @template T
+ * @implements AdapterInterface<T>
+ */
 abstract class AbstractCacheableCountPaginatorAdapter implements AdapterInterface
 {
     private ?int $count = null;

diff --git a/module/Core/src/RedirectRule/Model/Validation/RedirectRulesInputFilter.php b/module/Core/src/RedirectRule/Model/Validation/RedirectRulesInputFilter.php
@@ -17,6 +17,7 @@
 use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 use function Shlinkio\Shlink\Core\enumValues;
 
+/** @extends InputFilter<mixed> */
 class RedirectRulesInputFilter extends InputFilter
 {
     public const REDIRECT_RULES = 'redirectRules';
@@ -44,6 +45,9 @@ public static function initialize(array $rawData): self
         return $instance;
     }
 
+    /**
+     * @return InputFilter<mixed>
+     */
     private static function createRedirectRuleInputFilter(): InputFilter
     {
         $redirectRuleInputFilter = new InputFilter();
@@ -60,6 +64,9 @@ private static function createRedirectRuleInputFilter(): InputFilter
         return $redirectRuleInputFilter;
     }
 
+    /**
+     * @return InputFilter<mixed>
+     */
     private static function createRedirectConditionInputFilter(): InputFilter
     {
         $redirectConditionInputFilter = new InputFilter();

diff --git a/module/Core/src/ShortUrl/Entity/ShortUrl.php b/module/Core/src/ShortUrl/Entity/ShortUrl.php
@@ -37,8 +37,8 @@ class ShortUrl extends AbstractEntity
 {
     /**
      * @param Collection<int, Tag> $tags
-     * @param Collection<int, Visit> & Selectable $visits
-     * @param Collection<int, ShortUrlVisitsCount> & Selectable $visitsCounts
+     * @param Collection<int, Visit> & Selectable<int, Visit> $visits
+     * @param Collection<int, ShortUrlVisitsCount> & Selectable<int, ShortUrlVisitsCount> $visitsCounts
      */
     private function __construct(
         private string $longUrl,
@@ -213,7 +213,7 @@ public function mostRecentImportedVisitDate(): ?Chronos
     }
 
     /**
-     * @param Collection<int, Visit> & Selectable $visits
+     * @param Collection<int, Visit> & Selectable<int, Visit> $visits
      * @internal
      */
     public function setVisits(Collection & Selectable $visits): self

diff --git a/module/Core/src/ShortUrl/Model/Validation/ShortUrlInputFilter.php b/module/Core/src/ShortUrl/Model/Validation/ShortUrlInputFilter.php
@@ -20,6 +20,7 @@
 use const Shlinkio\Shlink\LOOSE_URI_MATCHER;
 use const Shlinkio\Shlink\MIN_SHORT_CODES_LENGTH;
 
+/** @extends InputFilter<mixed> */
 class ShortUrlInputFilter extends InputFilter
 {
     // Fields for creation only

diff --git a/module/Core/src/ShortUrl/Model/Validation/ShortUrlsParamsInputFilter.php b/module/Core/src/ShortUrl/Model/Validation/ShortUrlsParamsInputFilter.php
@@ -13,6 +13,7 @@
 
 use function Shlinkio\Shlink\Core\enumValues;
 
+/** @extends InputFilter<mixed> */
 class ShortUrlsParamsInputFilter extends InputFilter
 {
     public const PAGE = 'page';

diff --git a/module/Core/src/ShortUrl/Paginator/Adapter/ShortUrlRepositoryAdapter.php b/module/Core/src/ShortUrl/Paginator/Adapter/ShortUrlRepositoryAdapter.php
@@ -6,11 +6,13 @@
 
 use Pagerfanta\Adapter\AdapterInterface;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlsParams;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlWithVisitsSummary;
 use Shlinkio\Shlink\Core\ShortUrl\Persistence\ShortUrlsCountFiltering;
 use Shlinkio\Shlink\Core\ShortUrl\Persistence\ShortUrlsListFiltering;
 use Shlinkio\Shlink\Core\ShortUrl\Repository\ShortUrlListRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
+/** @implements AdapterInterface<ShortUrlWithVisitsSummary> */
 readonly class ShortUrlRepositoryAdapter implements AdapterInterface
 {
     public function __construct(

diff --git a/module/Core/src/ShortUrl/Repository/CrawlableShortCodesQuery.php b/module/Core/src/ShortUrl/Repository/CrawlableShortCodesQuery.php
@@ -7,6 +7,7 @@
 use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
 use Shlinkio\Shlink\Core\ShortUrl\Entity\ShortUrl;
 
+/** @extends EntitySpecificationRepository<ShortUrl> */
 class CrawlableShortCodesQuery extends EntitySpecificationRepository implements CrawlableShortCodesQueryInterface
 {
     /**

diff --git a/module/Core/src/ShortUrl/Repository/ExpiredShortUrlsRepository.php b/module/Core/src/ShortUrl/Repository/ExpiredShortUrlsRepository.php
@@ -13,6 +13,7 @@
 
 use function sprintf;
 
+/** @extends EntitySpecificationRepository<ShortUrl> */
 class ExpiredShortUrlsRepository extends EntitySpecificationRepository implements ExpiredShortUrlsRepositoryInterface
 {
     /**

diff --git a/module/Core/src/ShortUrl/Repository/ShortUrlListRepository.php b/module/Core/src/ShortUrl/Repository/ShortUrlListRepository.php
@@ -20,6 +20,7 @@
 use function Shlinkio\Shlink\Core\ArrayUtils\map;
 use function sprintf;
 
+/** @extends EntitySpecificationRepository<ShortUrl> */
 class ShortUrlListRepository extends EntitySpecificationRepository implements ShortUrlListRepositoryInterface
 {
     /**

diff --git a/module/Core/src/ShortUrl/Repository/ShortUrlRepository.php b/module/Core/src/ShortUrl/Repository/ShortUrlRepository.php
@@ -20,6 +20,7 @@
 use function count;
 use function strtolower;
 
+/** @extends EntitySpecificationRepository<ShortUrl> */
 class ShortUrlRepository extends EntitySpecificationRepository implements ShortUrlRepositoryInterface
 {
     public function findOneWithDomainFallback(ShortUrlIdentifier $identifier, ShortUrlMode $shortUrlMode): ?ShortUrl

diff --git a/module/Core/src/ShortUrl/Repository/ShortUrlRepositoryInterface.php b/module/Core/src/ShortUrl/Repository/ShortUrlRepositoryInterface.php
@@ -13,6 +13,7 @@
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlMode;
 use Shlinkio\Shlink\Importer\Model\ImportedShlinkUrl;
 
+/** @extends ObjectRepository<ShortUrl> */
 interface ShortUrlRepositoryInterface extends ObjectRepository, EntitySpecificationRepositoryInterface
 {
     public function findOneWithDomainFallback(ShortUrlIdentifier $identifier, ShortUrlMode $shortUrlMode): ?ShortUrl;

diff --git a/module/Core/src/ShortUrl/ShortUrlListService.php b/module/Core/src/ShortUrl/ShortUrlListService.php
@@ -7,7 +7,6 @@
 use Shlinkio\Shlink\Common\Paginator\Paginator;
 use Shlinkio\Shlink\Core\Options\UrlShortenerOptions;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlsParams;
-use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlWithVisitsSummary;
 use Shlinkio\Shlink\Core\ShortUrl\Paginator\Adapter\ShortUrlRepositoryAdapter;
 use Shlinkio\Shlink\Core\ShortUrl\Repository\ShortUrlListRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
@@ -21,7 +20,7 @@ public function __construct(
     }
 
     /**
-     * @return ShortUrlWithVisitsSummary[]|Paginator
+     * @inheritDoc
      */
     public function listShortUrls(ShortUrlsParams $params, ?ApiKey $apiKey = null): Paginator
     {

diff --git a/module/Core/src/ShortUrl/ShortUrlListServiceInterface.php b/module/Core/src/ShortUrl/ShortUrlListServiceInterface.php
@@ -12,7 +12,7 @@
 interface ShortUrlListServiceInterface
 {
     /**
-     * @return ShortUrlWithVisitsSummary[]|Paginator
+     * @return Paginator<ShortUrlWithVisitsSummary>
      */
     public function listShortUrls(ShortUrlsParams $params, ?ApiKey $apiKey = null): Paginator;
 }