2016-05-01 10:54:56 -05:00
|
|
|
<?php
|
2019-10-05 10:26:10 -05:00
|
|
|
|
2017-10-12 03:13:20 -05:00
|
|
|
declare(strict_types=1);
|
|
|
|
|
2021-02-08 12:50:17 -06:00
|
|
|
namespace ShlinkioTest\Shlink\Core\Visit;
|
2016-05-01 10:54:56 -05:00
|
|
|
|
|
|
|
use Doctrine\ORM\EntityManager;
|
2017-03-24 14:34:18 -05:00
|
|
|
use PHPUnit\Framework\TestCase;
|
2016-05-01 10:54:56 -05:00
|
|
|
use Prophecy\Argument;
|
2020-11-02 04:50:19 -06:00
|
|
|
use Prophecy\PhpUnit\ProphecyTrait;
|
2016-07-30 15:55:28 -05:00
|
|
|
use Prophecy\Prophecy\ObjectProphecy;
|
2019-07-13 05:04:21 -05:00
|
|
|
use Psr\EventDispatcher\EventDispatcherInterface;
|
2016-07-19 11:01:39 -05:00
|
|
|
use Shlinkio\Shlink\Core\Entity\ShortUrl;
|
2016-07-30 15:55:28 -05:00
|
|
|
use Shlinkio\Shlink\Core\Entity\Visit;
|
2021-02-09 13:25:28 -06:00
|
|
|
use Shlinkio\Shlink\Core\EventDispatcher\Event\UrlVisited;
|
2018-10-18 13:19:22 -05:00
|
|
|
use Shlinkio\Shlink\Core\Model\Visitor;
|
2021-05-16 02:30:04 -05:00
|
|
|
use Shlinkio\Shlink\Core\Options\TrackingOptions;
|
2021-02-08 12:50:17 -06:00
|
|
|
use Shlinkio\Shlink\Core\Visit\VisitsTracker;
|
2020-02-01 10:34:16 -06:00
|
|
|
|
2016-05-01 10:54:56 -05:00
|
|
|
class VisitsTrackerTest extends TestCase
|
|
|
|
{
|
2020-11-02 04:50:19 -06:00
|
|
|
use ProphecyTrait;
|
|
|
|
|
2019-12-29 15:48:40 -06:00
|
|
|
private VisitsTracker $visitsTracker;
|
|
|
|
private ObjectProphecy $em;
|
|
|
|
private ObjectProphecy $eventDispatcher;
|
2021-05-16 02:30:04 -05:00
|
|
|
private TrackingOptions $options;
|
2016-07-30 15:55:28 -05:00
|
|
|
|
2019-02-16 03:53:45 -06:00
|
|
|
public function setUp(): void
|
2016-07-30 15:55:28 -05:00
|
|
|
{
|
|
|
|
$this->em = $this->prophesize(EntityManager::class);
|
2021-04-07 04:33:23 -05:00
|
|
|
|
2019-07-13 05:04:21 -05:00
|
|
|
$this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
|
2021-05-16 02:30:04 -05:00
|
|
|
$this->options = new TrackingOptions();
|
2019-07-13 05:04:21 -05:00
|
|
|
|
2021-02-10 13:09:25 -06:00
|
|
|
$this->visitsTracker = new VisitsTracker($this->em->reveal(), $this->eventDispatcher->reveal(), $this->options);
|
2016-07-30 15:55:28 -05:00
|
|
|
}
|
|
|
|
|
2021-02-09 13:34:12 -06:00
|
|
|
/**
|
|
|
|
* @test
|
|
|
|
* @dataProvider provideTrackingMethodNames
|
|
|
|
*/
|
|
|
|
public function trackPersistsVisitAndDispatchesEvent(string $method, array $args): void
|
2016-05-01 10:54:56 -05:00
|
|
|
{
|
2021-04-07 04:33:23 -05:00
|
|
|
$persist = $this->em->persist(Argument::that(fn (Visit $visit) => $visit->setId('1')))->will(function (): void {
|
|
|
|
});
|
2016-07-30 15:55:28 -05:00
|
|
|
|
2021-02-09 13:34:12 -06:00
|
|
|
$this->visitsTracker->{$method}(...$args);
|
2019-07-13 05:04:21 -05:00
|
|
|
|
2021-04-07 04:33:23 -05:00
|
|
|
$persist->shouldHaveBeenCalledOnce();
|
|
|
|
$this->em->flush()->shouldHaveBeenCalledOnce();
|
2021-02-09 13:25:28 -06:00
|
|
|
$this->eventDispatcher->dispatch(Argument::type(UrlVisited::class))->shouldHaveBeenCalled();
|
2016-07-30 15:55:28 -05:00
|
|
|
}
|
2021-02-09 13:34:12 -06:00
|
|
|
|
2021-05-16 02:51:52 -05:00
|
|
|
/**
|
|
|
|
* @test
|
|
|
|
* @dataProvider provideTrackingMethodNames
|
|
|
|
*/
|
|
|
|
public function trackingIsSkippedCompletelyWhenDisabledFromOptions(string $method, array $args): void
|
|
|
|
{
|
|
|
|
$this->options->disableTracking = true;
|
|
|
|
|
|
|
|
$this->visitsTracker->{$method}(...$args);
|
|
|
|
|
|
|
|
$this->eventDispatcher->dispatch(Argument::cetera())->shouldNotHaveBeenCalled();
|
|
|
|
$this->em->persist(Argument::cetera())->shouldNotHaveBeenCalled();
|
|
|
|
$this->em->flush()->shouldNotHaveBeenCalled();
|
|
|
|
}
|
|
|
|
|
2021-02-09 13:34:12 -06:00
|
|
|
public function provideTrackingMethodNames(): iterable
|
|
|
|
{
|
|
|
|
yield 'track' => ['track', [ShortUrl::createEmpty(), Visitor::emptyInstance()]];
|
|
|
|
yield 'trackInvalidShortUrlVisit' => ['trackInvalidShortUrlVisit', [Visitor::emptyInstance()]];
|
|
|
|
yield 'trackBaseUrlVisit' => ['trackBaseUrlVisit', [Visitor::emptyInstance()]];
|
|
|
|
yield 'trackRegularNotFoundVisit' => ['trackRegularNotFoundVisit', [Visitor::emptyInstance()]];
|
|
|
|
}
|
2021-02-10 13:09:25 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @test
|
|
|
|
* @dataProvider provideOrphanTrackingMethodNames
|
|
|
|
*/
|
|
|
|
public function orphanVisitsAreNotTrackedWhenDisabled(string $method): void
|
|
|
|
{
|
|
|
|
$this->options->trackOrphanVisits = false;
|
|
|
|
|
|
|
|
$this->visitsTracker->{$method}(Visitor::emptyInstance());
|
|
|
|
|
|
|
|
$this->eventDispatcher->dispatch(Argument::cetera())->shouldNotHaveBeenCalled();
|
|
|
|
$this->em->persist(Argument::cetera())->shouldNotHaveBeenCalled();
|
|
|
|
$this->em->flush()->shouldNotHaveBeenCalled();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function provideOrphanTrackingMethodNames(): iterable
|
|
|
|
{
|
|
|
|
yield 'trackInvalidShortUrlVisit' => ['trackInvalidShortUrlVisit'];
|
|
|
|
yield 'trackBaseUrlVisit' => ['trackBaseUrlVisit'];
|
|
|
|
yield 'trackRegularNotFoundVisit' => ['trackRegularNotFoundVisit'];
|
|
|
|
}
|
2016-05-01 10:54:56 -05:00
|
|
|
}
|