Refactored global repositories into their own proper namespaces

module/Core/src/Visit/Geolocation/VisitLocator.php

@@ -8,7 +8,7 @@ use Doctrine\ORM\EntityManagerInterface;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\Entity\VisitLocation;
 use Shlinkio\Shlink\Core\Exception\IpCannotBeLocatedException;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\IpGeolocation\Model\Location;
 
 class VisitLocator implements VisitLocatorInterface

module/Core/src/Visit/Paginator/Adapter/DomainVisitsPaginatorAdapter.php

@@ -5,10 +5,10 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Visit\Paginator\Adapter;
 
 use Shlinkio\Shlink\Core\Paginator\Adapter\AbstractCacheableCountPaginatorAdapter;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
 class DomainVisitsPaginatorAdapter extends AbstractCacheableCountPaginatorAdapter

module/Core/src/Visit/Paginator/Adapter/NonOrphanVisitsPaginatorAdapter.php

@@ -5,10 +5,10 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Visit\Paginator\Adapter;
 
 use Shlinkio\Shlink\Core\Paginator\Adapter\AbstractCacheableCountPaginatorAdapter;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
 class NonOrphanVisitsPaginatorAdapter extends AbstractCacheableCountPaginatorAdapter

module/Core/src/Visit/Paginator/Adapter/OrphanVisitsPaginatorAdapter.php

@@ -5,10 +5,10 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Visit\Paginator\Adapter;
 
 use Shlinkio\Shlink\Core\Paginator\Adapter\AbstractCacheableCountPaginatorAdapter;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 
 class OrphanVisitsPaginatorAdapter extends AbstractCacheableCountPaginatorAdapter
 {

module/Core/src/Visit/Paginator/Adapter/ShortUrlVisitsPaginatorAdapter.php

@@ -5,11 +5,11 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Visit\Paginator\Adapter;
 
 use Shlinkio\Shlink\Core\Paginator\Adapter\AbstractCacheableCountPaginatorAdapter;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
 class ShortUrlVisitsPaginatorAdapter extends AbstractCacheableCountPaginatorAdapter

module/Core/src/Visit/Paginator/Adapter/TagVisitsPaginatorAdapter.php

@@ -5,10 +5,10 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Core\Visit\Paginator\Adapter;
 
 use Shlinkio\Shlink\Core\Paginator\Adapter\AbstractCacheableCountPaginatorAdapter;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
 class TagVisitsPaginatorAdapter extends AbstractCacheableCountPaginatorAdapter

module/Core/src/Visit/Repository/VisitRepository.php

@@ -0,0 +1,289 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Visit\Repository;
+
+use Doctrine\ORM\Query\ResultSetMappingBuilder;
+use Doctrine\ORM\QueryBuilder;
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
+use Shlinkio\Shlink\Common\Util\DateRange;
+use Shlinkio\Shlink\Core\Entity\ShortUrl;
+use Shlinkio\Shlink\Core\Entity\Visit;
+use Shlinkio\Shlink\Core\Entity\VisitLocation;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\ShortUrl\Repository\ShortUrlRepositoryInterface;
+use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
+use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+use Shlinkio\Shlink\Core\Visit\Spec\CountOfNonOrphanVisits;
+use Shlinkio\Shlink\Core\Visit\Spec\CountOfOrphanVisits;
+
+use const PHP_INT_MAX;
+
+class VisitRepository extends EntitySpecificationRepository implements VisitRepositoryInterface
+{
+    /**
+     * @return iterable|Visit[]
+     */
+    public function findUnlocatedVisits(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable
+    {
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->select('v')
+           ->from(Visit::class, 'v')
+           ->where($qb->expr()->isNull('v.visitLocation'));
+
+        return $this->visitsIterableForQuery($qb, $blockSize);
+    }
+
+    /**
+     * @return iterable|Visit[]
+     */
+    public function findVisitsWithEmptyLocation(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable
+    {
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->select('v')
+           ->from(Visit::class, 'v')
+           ->join('v.visitLocation', 'vl')
+           ->where($qb->expr()->isNotNull('v.visitLocation'))
+           ->andWhere($qb->expr()->eq('vl.isEmpty', ':isEmpty'))
+           ->setParameter('isEmpty', true);
+
+        return $this->visitsIterableForQuery($qb, $blockSize);
+    }
+
+    public function findAllVisits(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable
+    {
+        $qb = $this->createQueryBuilder('v');
+        return $this->visitsIterableForQuery($qb, $blockSize);
+    }
+
+    private function visitsIterableForQuery(QueryBuilder $qb, int $blockSize): iterable
+    {
+        $originalQueryBuilder = $qb->setMaxResults($blockSize)
+                                   ->orderBy('v.id', 'ASC');
+        $lastId = '0';
+
+        do {
+            $qb = (clone $originalQueryBuilder)->andWhere($qb->expr()->gt('v.id', $lastId));
+            $iterator = $qb->getQuery()->toIterable();
+            $resultsFound = false;
+            /** @var Visit|null $lastProcessedVisit */
+            $lastProcessedVisit = null;
+
+            foreach ($iterator as $key => $visit) {
+                $resultsFound = true;
+                $lastProcessedVisit = $visit;
+                yield $key => $visit;
+            }
+
+            // As the query is ordered by ID, we can take the last one every time in order to exclude the whole list
+            $lastId = $lastProcessedVisit?->getId() ?? $lastId;
+        } while ($resultsFound);
+    }
+
+    /**
+     * @return Visit[]
+     */
+    public function findVisitsByShortCode(ShortUrlIdentifier $identifier, VisitsListFiltering $filtering): array
+    {
+        $qb = $this->createVisitsByShortCodeQueryBuilder($identifier, $filtering);
+        return $this->resolveVisitsWithNativeQuery($qb, $filtering->limit, $filtering->offset);
+    }
+
+    public function countVisitsByShortCode(ShortUrlIdentifier $identifier, VisitsCountFiltering $filtering): int
+    {
+        $qb = $this->createVisitsByShortCodeQueryBuilder($identifier, $filtering);
+        $qb->select('COUNT(v.id)');
+
+        return (int) $qb->getQuery()->getSingleScalarResult();
+    }
+
+    private function createVisitsByShortCodeQueryBuilder(
+        ShortUrlIdentifier $identifier,
+        VisitsCountFiltering $filtering,
+    ): QueryBuilder {
+        /** @var ShortUrlRepositoryInterface $shortUrlRepo */
+        $shortUrlRepo = $this->getEntityManager()->getRepository(ShortUrl::class);
+        $shortUrlId = $shortUrlRepo->findOne($identifier, $filtering->apiKey?->spec())?->getId() ?? '-1';
+
+        // Parameters in this query need to be part of the query itself, as we need to use it as sub-query later
+        // Since they are not provided by the caller, it's reasonably safe
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->from(Visit::class, 'v')
+           ->where($qb->expr()->eq('v.shortUrl', $shortUrlId));
+
+        if ($filtering->excludeBots) {
+            $qb->andWhere($qb->expr()->eq('v.potentialBot', 'false'));
+        }
+
+        // Apply date range filtering
+        $this->applyDatesInline($qb, $filtering->dateRange);
+
+        return $qb;
+    }
+
+    public function findVisitsByTag(string $tag, VisitsListFiltering $filtering): array
+    {
+        $qb = $this->createVisitsByTagQueryBuilder($tag, $filtering);
+        return $this->resolveVisitsWithNativeQuery($qb, $filtering->limit, $filtering->offset);
+    }
+
+    public function countVisitsByTag(string $tag, VisitsCountFiltering $filtering): int
+    {
+        $qb = $this->createVisitsByTagQueryBuilder($tag, $filtering);
+        $qb->select('COUNT(v.id)');
+
+        return (int) $qb->getQuery()->getSingleScalarResult();
+    }
+
+    private function createVisitsByTagQueryBuilder(string $tag, VisitsCountFiltering $filtering): QueryBuilder
+    {
+        // Parameters in this query need to be inlined, not bound, as we need to use it as sub-query later.
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->from(Visit::class, 'v')
+           ->join('v.shortUrl', 's')
+           ->join('s.tags', 't')
+           ->where($qb->expr()->eq('t.name', $this->getEntityManager()->getConnection()->quote($tag)));
+
+        if ($filtering->excludeBots) {
+            $qb->andWhere($qb->expr()->eq('v.potentialBot', 'false'));
+        }
+
+        $this->applyDatesInline($qb, $filtering->dateRange);
+        $this->applySpecification($qb, $filtering->apiKey?->inlinedSpec(), 'v');
+
+        return $qb;
+    }
+
+    /**
+     * @return Visit[]
+     */
+    public function findVisitsByDomain(string $domain, VisitsListFiltering $filtering): array
+    {
+        $qb = $this->createVisitsByDomainQueryBuilder($domain, $filtering);
+        return $this->resolveVisitsWithNativeQuery($qb, $filtering->limit, $filtering->offset);
+    }
+
+    public function countVisitsByDomain(string $domain, VisitsCountFiltering $filtering): int
+    {
+        $qb = $this->createVisitsByDomainQueryBuilder($domain, $filtering);
+        $qb->select('COUNT(v.id)');
+
+        return (int) $qb->getQuery()->getSingleScalarResult();
+    }
+
+    private function createVisitsByDomainQueryBuilder(string $domain, VisitsCountFiltering $filtering): QueryBuilder
+    {
+        // Parameters in this query need to be inlined, not bound, as we need to use it as sub-query later.
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->from(Visit::class, 'v')
+           ->join('v.shortUrl', 's');
+
+        if ($domain === 'DEFAULT') {
+            $qb->where($qb->expr()->isNull('s.domain'));
+        } else {
+            $qb->join('s.domain', 'd')
+               ->where($qb->expr()->eq('d.authority', $this->getEntityManager()->getConnection()->quote($domain)));
+        }
+
+        if ($filtering->excludeBots) {
+            $qb->andWhere($qb->expr()->eq('v.potentialBot', 'false'));
+        }
+
+        $this->applyDatesInline($qb, $filtering->dateRange);
+        $this->applySpecification($qb, $filtering->apiKey?->inlinedSpec(), 'v');
+
+        return $qb;
+    }
+
+    public function findOrphanVisits(VisitsListFiltering $filtering): array
+    {
+        $qb = $this->createAllVisitsQueryBuilder($filtering);
+        $qb->andWhere($qb->expr()->isNull('v.shortUrl'));
+        return $this->resolveVisitsWithNativeQuery($qb, $filtering->limit, $filtering->offset);
+    }
+
+    public function countOrphanVisits(VisitsCountFiltering $filtering): int
+    {
+        return (int) $this->matchSingleScalarResult(new CountOfOrphanVisits($filtering));
+    }
+
+    /**
+     * @return Visit[]
+     */
+    public function findNonOrphanVisits(VisitsListFiltering $filtering): array
+    {
+        $qb = $this->createAllVisitsQueryBuilder($filtering);
+        $qb->andWhere($qb->expr()->isNotNull('v.shortUrl'));
+
+        $this->applySpecification($qb, $filtering->apiKey?->inlinedSpec());
+
+        return $this->resolveVisitsWithNativeQuery($qb, $filtering->limit, $filtering->offset);
+    }
+
+    public function countNonOrphanVisits(VisitsCountFiltering $filtering): int
+    {
+        return (int) $this->matchSingleScalarResult(new CountOfNonOrphanVisits($filtering));
+    }
+
+    private function createAllVisitsQueryBuilder(VisitsListFiltering $filtering): QueryBuilder
+    {
+        // Parameters in this query need to be inlined, not bound, as we need to use it as sub-query later
+        // Since they are not provided by the caller, it's reasonably safe
+        $qb = $this->getEntityManager()->createQueryBuilder();
+        $qb->from(Visit::class, 'v');
+
+        if ($filtering->excludeBots) {
+            $qb->andWhere($qb->expr()->eq('v.potentialBot', 'false'));
+        }
+
+        $this->applyDatesInline($qb, $filtering->dateRange);
+
+        return $qb;
+    }
+
+    private function applyDatesInline(QueryBuilder $qb, ?DateRange $dateRange): void
+    {
+        $conn = $this->getEntityManager()->getConnection();
+
+        if ($dateRange?->startDate !== null) {
+            $qb->andWhere($qb->expr()->gte('v.date', $conn->quote($dateRange->startDate->toDateTimeString())));
+        }
+        if ($dateRange?->endDate !== null) {
+            $qb->andWhere($qb->expr()->lte('v.date', $conn->quote($dateRange->endDate->toDateTimeString())));
+        }
+    }
+
+    private function resolveVisitsWithNativeQuery(QueryBuilder $qb, ?int $limit, ?int $offset): array
+    {
+        // TODO Order by date and ID, not just by ID (order by date DESC, id DESC).
+        //      That ensures imported visits are properly ordered even if inserted in wrong chronological order.
+
+        $qb->select('v.id')
+           ->orderBy('v.id', 'DESC')
+           // Falling back to values that will behave as no limit/offset, but will work around MS SQL not allowing
+           // order on sub-queries without offset
+           ->setMaxResults($limit ?? PHP_INT_MAX)
+           ->setFirstResult($offset ?? 0);
+        $subQuery = $qb->getQuery()->getSQL();
+
+        // A native query builder needs to be used here, because DQL and ORM query builders do not support
+        // sub-queries at "from" and "join" level.
+        // If no sub-query is used, then performance drops dramatically while the "offset" grows.
+        $nativeQb = $this->getEntityManager()->getConnection()->createQueryBuilder();
+        $nativeQb->select('v.id AS visit_id', 'v.*', 'vl.*')
+                 ->from('visits', 'v')
+                 // @phpstan-ignore-next-line
+                 ->join('v', '(' . $subQuery . ')', 'sq', $nativeQb->expr()->eq('sq.id_0', 'v.id'))
+                 ->leftJoin('v', 'visit_locations', 'vl', $nativeQb->expr()->eq('v.visit_location_id', 'vl.id'))
+                 ->orderBy('v.id', 'DESC');
+
+        $rsm = new ResultSetMappingBuilder($this->getEntityManager());
+        $rsm->addRootEntityFromClassMetadata(Visit::class, 'v', ['id' => 'visit_id']);
+        $rsm->addJoinedEntityFromClassMetadata(VisitLocation::class, 'vl', 'v', 'visitLocation', [
+            'id' => 'visit_location_id',
+        ]);
+
+        return $this->getEntityManager()->createNativeQuery($nativeQb->getSQL(), $rsm)->getResult();
+    }
+}

module/Core/src/Visit/Repository/VisitRepositoryInterface.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Visit\Repository;
+
+use Doctrine\Persistence\ObjectRepository;
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepositoryInterface;
+use Shlinkio\Shlink\Core\Entity\Visit;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
+use Shlinkio\Shlink\Core\Visit\Persistence\VisitsListFiltering;
+
+// TODO Split into VisitsListsRepository and VisitsLocationRepository
+interface VisitRepositoryInterface extends ObjectRepository, EntitySpecificationRepositoryInterface
+{
+    public const DEFAULT_BLOCK_SIZE = 10000;
+
+    /**
+     * @return iterable|Visit[]
+     */
+    public function findUnlocatedVisits(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable;
+
+    /**
+     * @return iterable|Visit[]
+     */
+    public function findVisitsWithEmptyLocation(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable;
+
+    /**
+     * @return iterable|Visit[]
+     */
+    public function findAllVisits(int $blockSize = self::DEFAULT_BLOCK_SIZE): iterable;
+
+    /**
+     * @return Visit[]
+     */
+    public function findVisitsByShortCode(ShortUrlIdentifier $identifier, VisitsListFiltering $filtering): array;
+
+    public function countVisitsByShortCode(ShortUrlIdentifier $identifier, VisitsCountFiltering $filtering): int;
+
+    /**
+     * @return Visit[]
+     */
+    public function findVisitsByTag(string $tag, VisitsListFiltering $filtering): array;
+
+    public function countVisitsByTag(string $tag, VisitsCountFiltering $filtering): int;
+
+    /**
+     * @return Visit[]
+     */
+    public function findVisitsByDomain(string $domain, VisitsListFiltering $filtering): array;
+
+    public function countVisitsByDomain(string $domain, VisitsCountFiltering $filtering): int;
+
+    /**
+     * @return Visit[]
+     */
+    public function findOrphanVisits(VisitsListFiltering $filtering): array;
+
+    public function countOrphanVisits(VisitsCountFiltering $filtering): int;
+
+    /**
+     * @return Visit[]
+     */
+    public function findNonOrphanVisits(VisitsListFiltering $filtering): array;
+
+    public function countNonOrphanVisits(VisitsCountFiltering $filtering): int;
+}

module/Core/src/Visit/VisitsStatsHelper.php

@@ -15,11 +15,9 @@ use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\Exception\DomainNotFoundException;
 use Shlinkio\Shlink\Core\Exception\ShortUrlNotFoundException;
 use Shlinkio\Shlink\Core\Exception\TagNotFoundException;
-use Shlinkio\Shlink\Core\Repository\ShortUrlRepositoryInterface;
-use Shlinkio\Shlink\Core\Repository\TagRepository;
-use Shlinkio\Shlink\Core\Repository\VisitRepository;
-use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\ShortUrl\Repository\ShortUrlRepositoryInterface;
+use Shlinkio\Shlink\Core\Tag\Repository\TagRepository;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsParams;
 use Shlinkio\Shlink\Core\Visit\Model\VisitsStats;
 use Shlinkio\Shlink\Core\Visit\Paginator\Adapter\DomainVisitsPaginatorAdapter;
@@ -28,6 +26,8 @@ use Shlinkio\Shlink\Core\Visit\Paginator\Adapter\OrphanVisitsPaginatorAdapter;
 use Shlinkio\Shlink\Core\Visit\Paginator\Adapter\ShortUrlVisitsPaginatorAdapter;
 use Shlinkio\Shlink\Core\Visit\Paginator\Adapter\TagVisitsPaginatorAdapter;
 use Shlinkio\Shlink\Core\Visit\Persistence\VisitsCountFiltering;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepository;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitRepositoryInterface;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 
 class VisitsStatsHelper implements VisitsStatsHelperInterface