Added Created endpoint to serve visits by tag

module/Core/src/Paginator/Adapter/VisitsForTagPaginatorAdapter.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Paginator\Adapter;
+
+use Laminas\Paginator\Adapter\AdapterInterface;
+use Shlinkio\Shlink\Core\Model\VisitsParams;
+use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
+
+class VisitsForTagPaginatorAdapter implements AdapterInterface
+{
+    private VisitRepositoryInterface $visitRepository;
+    private string $tag;
+    private VisitsParams $params;
+
+    private ?int $count = null;
+
+    public function __construct(VisitRepositoryInterface $visitRepository, string $tag, VisitsParams $params)
+    {
+        $this->visitRepository = $visitRepository;
+        $this->params = $params;
+        $this->tag = $tag;
+    }
+
+    public function getItems($offset, $itemCountPerPage): array // phpcs:ignore
+    {
+        return $this->visitRepository->findVisitsByTag(
+            $this->tag,
+            $this->params->getDateRange(),
+            $itemCountPerPage,
+            $offset,
+        );
+    }
+
+    public function count(): int
+    {
+        // Since a new adapter instance is created every time visits are fetched, it is reasonably safe to internally
+        // cache the count value.
+        // The reason it is cached is because the Paginator is actually calling the method twice.
+        // An inconsistent value could be returned if between the first call and the second one, a new visit is created.
+        // However, it's almost instant, and then the adapter instance is discarded immediately after.
+
+        if ($this->count !== null) {
+            return $this->count;
+        }
+
+        return $this->count = $this->visitRepository->countVisitsByTag($this->tag, $this->params->getDateRange());
+    }
+}

module/Core/src/Service/VisitsTracker.php

@@ -8,15 +8,19 @@ use Doctrine\ORM;
 use Laminas\Paginator\Paginator;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
+use Shlinkio\Shlink\Core\Entity\Tag;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\EventDispatcher\ShortUrlVisited;
 use Shlinkio\Shlink\Core\Exception\ShortUrlNotFoundException;
+use Shlinkio\Shlink\Core\Exception\TagNotFoundException;
 use Shlinkio\Shlink\Core\Model\ShortUrlIdentifier;
 use Shlinkio\Shlink\Core\Model\Visitor;
 use Shlinkio\Shlink\Core\Model\VisitsParams;
+use Shlinkio\Shlink\Core\Paginator\Adapter\VisitsForTagPaginatorAdapter;
 use Shlinkio\Shlink\Core\Paginator\Adapter\VisitsPaginatorAdapter;
 use Shlinkio\Shlink\Core\Repository\ShortUrlRepositoryInterface;
-use Shlinkio\Shlink\Core\Repository\VisitRepository;
+use Shlinkio\Shlink\Core\Repository\TagRepository;
+use Shlinkio\Shlink\Core\Repository\VisitRepositoryInterface;
 
 class VisitsTracker implements VisitsTrackerInterface
 {
@@ -34,9 +38,6 @@ class VisitsTracker implements VisitsTrackerInterface
         $this->anonymizeRemoteAddr = $anonymizeRemoteAddr;
     }
 
-    /**
-     * Tracks a new visit to provided short code from provided visitor
-     */
     public function track(ShortUrl $shortUrl, Visitor $visitor): void
     {
         $visit = new Visit($shortUrl, $visitor, $this->anonymizeRemoteAddr);
@@ -48,8 +49,6 @@ class VisitsTracker implements VisitsTrackerInterface
     }
 
     /**
-     * Returns the visits on certain short code
-     *
      * @return Visit[]|Paginator
      * @throws ShortUrlNotFoundException
      */
@@ -61,7 +60,7 @@ class VisitsTracker implements VisitsTrackerInterface
             throw ShortUrlNotFoundException::fromNotFound($identifier);
         }
 
-        /** @var VisitRepository $repo */
+        /** @var VisitRepositoryInterface $repo */
         $repo = $this->em->getRepository(Visit::class);
         $paginator = new Paginator(new VisitsPaginatorAdapter($repo, $identifier, $params));
         $paginator->setItemCountPerPage($params->getItemsPerPage())
@@ -69,4 +68,26 @@ class VisitsTracker implements VisitsTrackerInterface
 
         return $paginator;
     }
+
+    /**
+     * @return Visit[]|Paginator
+     * @throws TagNotFoundException
+     */
+    public function visitsForTag(string $tag, VisitsParams $params): Paginator
+    {
+        /** @var TagRepository $tagRepo */
+        $tagRepo = $this->em->getRepository(Tag::class);
+        $count = $tagRepo->count(['name' => $tag]);
+        if ($count === 0) {
+            throw TagNotFoundException::fromTag($tag);
+        }
+
+        /** @var VisitRepositoryInterface $repo */
+        $repo = $this->em->getRepository(Visit::class);
+        $paginator = new Paginator(new VisitsForTagPaginatorAdapter($repo, $tag, $params));
+        $paginator->setItemCountPerPage($params->getItemsPerPage())
+                  ->setCurrentPageNumber($params->getPage());
+
+        return $paginator;
+    }
 }

module/Core/src/Service/VisitsTrackerInterface.php

@@ -8,22 +8,24 @@ use Laminas\Paginator\Paginator;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\Exception\ShortUrlNotFoundException;
+use Shlinkio\Shlink\Core\Exception\TagNotFoundException;
 use Shlinkio\Shlink\Core\Model\ShortUrlIdentifier;
 use Shlinkio\Shlink\Core\Model\Visitor;
 use Shlinkio\Shlink\Core\Model\VisitsParams;
 
 interface VisitsTrackerInterface
 {
-    /**
-     * Tracks a new visit to provided short code from provided visitor
-     */
     public function track(ShortUrl $shortUrl, Visitor $visitor): void;
 
     /**
-     * Returns the visits on certain short code
-     *
      * @return Visit[]|Paginator
      * @throws ShortUrlNotFoundException
      */
     public function info(ShortUrlIdentifier $identifier, VisitsParams $params): Paginator;
+
+    /**
+     * @return Visit[]|Paginator
+     * @throws TagNotFoundException
+     */
+    public function visitsForTag(string $tag, VisitsParams $params): Paginator;
 }