matomo/plugins/VisitsSummary/tests/Integration/VisitsSummaryTest.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\VisitsSummary\tests\Integration;

use Piwik\API\Request;
use Piwik\DataAccess\ArchiveTableCreator;
use Piwik\Db;
use Piwik\Plugins\VisitsSummary\VisitsSummary;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group VisitsSummary
 * @group VisitsSummaryTest
 * @group Plugins
 */
class VisitsSummaryTest extends IntegrationTestCase
{
    /**
     * @var VisitsSummary
     */
    private $plugin;

    protected $date = '2014-04-04';
    private $column = 'nb_users';

    public function setUp(): void
    {
        parent::setUp();
        $this->plugin = new VisitsSummary();

        $this->setSuperUser();

        Fixture::createSuperUser();
        Fixture::createWebsite('2014-01-01 00:00:00');
    }

    public function tearDown(): void
    {
        // clean up your test here if needed
        $tables = ArchiveTableCreator::getTablesArchivesInstalled();
        if (!empty($tables)) {
            Db::dropTables($tables);
        }
        parent::tearDown();
    }

    public function testEnrichProcessedReportIfVisitsSummaryGetShouldNotRemoveUsersIfSomeWereTracked()
    {
        $this->trackPageviewsWithUsers();

        $response = $this->requestProcessedGetReport();

        $this->assertUsersNotRemovedFromProcessedReport($response, $expectedUsers = null, $minExpectedUsers = 1);
    }

    public function testEnrichProcessedReportIfVisitsSummaryGetShouldNotRemoveUsersIfNoneWereTrackedThatDayButThatMonth()
    {
        $this->date = '2014-04-04';
        $this->trackPageviewsWithUsers();

        $this->date = '2014-04-05';
        $this->trackPageviewsWithoutUsers();

        $response = $this->requestProcessedGetReport();

        $this->assertUsersNotRemovedFromProcessedReport($response, $expectedUsers = 0.0);
    }

    public function testIsUsedInAtLeastOneSiteShouldRemoveUsersIfNoneWereTracked()
    {
        $this->trackPageviewsWithoutUsers();

        $response = $this->requestProcessedGetReport();

        $this->assertUsersRemovedFromProcessedReport($response);
    }

    private function assertUsersNotRemovedFromProcessedReport($response, $exactNumUsers = null, $minNumUsers = 0)
    {
        $table = $response['reportData'];

        if ($exactNumUsers !== null) {
            $this->assertSame(array($exactNumUsers), $table->getColumn($this->column));
        }

        if ($minNumUsers != 0) {
            $users = $table->getColumn($this->column);
            $user = array_shift($users);
            $this->assertGreaterThanOrEqual($minNumUsers, $user);
        }

        $numVisits = $table->getColumn('nb_visits');
        $numVisits = array_shift($numVisits);
        $this->assertGreaterThanOrEqual(2, $numVisits);

        $this->assertNotEmpty($response['metadata']['metrics'][$this->column]);
        $this->assertNotEmpty($response['metadata']['metricsDocumentation'][$this->column]);
        $this->assertNotEmpty($response['columns'][$this->column]);
    }

    private function assertUsersRemovedFromProcessedReport($response)
    {
        $table = $response['reportData'];
        $this->assertEquals(array(false), $table->getColumn($this->column));

        $numVisits = $table->getColumn('nb_visits');
        $numVisits = array_shift($numVisits);
        $this->assertGreaterThanOrEqual(2, $numVisits);

        $this->assertArrayNotHasKey($this->column, $response['metadata']['metrics']);
        $this->assertArrayNotHasKey($this->column, $response['metadata']['metricsDocumentation']);
        $this->assertArrayNotHasKey($this->column, $response['columns']);
    }

    private function requestProcessedGetReport()
    {
        return Request::processRequest('API.getProcessedReport', array(
            'idSite' => 1,
            'period' => 'day',
            'date'   => $this->date,
            'apiModule' => 'VisitsSummary',
            'apiAction' => 'get'
        ));
    }

    private function trackPageviewsWithUsers()
    {
        $this->trackPageviewsWithDifferentUsers(array('user1', false, 'user3'));
    }

    private function trackPageviewsWithoutUsers()
    {
        $this->trackPageviewsWithDifferentUsers(array(false, false, false));
    }

    private function trackPageviewsWithDifferentUsers($userIds)
    {
        foreach ($userIds as $index => $userId) {
            $tracker = $this->getTracker($index);
            $tracker->setForceNewVisit();
            $this->trackPageview($tracker, $userId, '/index/' . $index . '.html');
        }
    }

    private function trackPageview(\MatomoTracker $tracker, $userId, $url)
    {
        $tracker->setUrl('http://www.example.org' . $url);
        $tracker->setUserId($userId);
        $tracker->doTrackPageView($url);
    }

    private function getTracker($hoursOffset = 0)
    {
        $hour = 10;
        if ($hoursOffset) {
            $hour += $hoursOffset;
        }

        $date = sprintf('%s %d:20:01', $this->date, $hour);

        $tracker = Fixture::getTracker(1, $date, true, true);
        $tracker->setTokenAuth(Fixture::getTokenAuth());
        return $tracker;
    }

    private function setSuperUser()
    {
        FakeAccess::$superUser = true;
    }

    public function provideContainerConfig()
    {
        return array(
            'Piwik\Access' => new FakeAccess()
        );
    }
}