Shlinkio\Shlink\Core\Visit\VisitLocator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

97.44%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	locateVisitsWithEmptyLocation()	0	3	1
A	locateUnlocatedVisits()	0	3	1
A	locateAllVisits()	0	3	1
A	__construct()	0	7	1
A	locateVisits()	0	32	5
A	locateVisit()	0	13	2

<?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Core\Visit;

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\IpGeolocation\Model\Location;

class VisitLocator implements VisitLocatorInterface
{
    private EntityManagerInterface $em;
    private VisitRepositoryInterface $repo;

    public function __construct(EntityManagerInterface $em)
    {
        $this->em = $em;

        /** @var VisitRepositoryInterface $repo */
        $repo = $em->getRepository(Visit::class);
        $this->repo = $repo;
    }

    public function locateUnlocatedVisits(VisitGeolocationHelperInterface $helper): void
    {
        $this->locateVisits($this->repo->findUnlocatedVisits(), $helper);
    }

    public function locateVisitsWithEmptyLocation(VisitGeolocationHelperInterface $helper): void
    {
        $this->locateVisits($this->repo->findVisitsWithEmptyLocation(), $helper);
    }

    public function locateAllVisits(VisitGeolocationHelperInterface $helper): void
    {
        $this->locateVisits($this->repo->findAllVisits(), $helper);
    }

    /**
     * @param iterable|Visit[] $results
     */
    private function locateVisits(iterable $results, VisitGeolocationHelperInterface $helper): void
    {
        $count = 0;
        $persistBlock = 200;

        foreach ($results as $visit) {
            $count++;

            try {
                $location = $helper->geolocateVisit($visit);
            } catch (IpCannotBeLocatedException $e) {
                if (! $e->isNonLocatableAddress()) {
                    // Skip if the visit's IP could not be located because of an error
                    continue;
                }

                // If the IP address is non-locatable, locate it as empty to prevent next processes to pick it again
                $location = Location::emptyInstance();
            }

            $location = new VisitLocation($location);
            $this->locateVisit($visit, $location, $helper);

            // Flush and clear after X iterations
            if ($count % $persistBlock === 0) {
                $this->em->flush();
                $this->em->clear();
            }
        }

        $this->em->flush();
        $this->em->clear();
    }

    private function locateVisit(Visit $visit, VisitLocation $location, VisitGeolocationHelperInterface $helper): void
    {
        $prevLocation = $visit->getVisitLocation();

        $visit->locate($location);
        $this->em->persist($visit);

        // In order to avoid leaving orphan locations, remove the previous one
        if ($prevLocation !== null) {
            $this->em->remove($prevLocation);
        }

        $helper->onVisitLocated($location, $visit);
    }
}