tests/PHPUnit/System/SimulateAutoIncrementIntegerOverflowTest.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\Tests\System;

use Piwik\Common;
use Piwik\Db;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\OneVisitorTwoVisits;

/**
 * Simulates the case where there are more than 4 billion visits and pages, and check that Piwik
 * can handle this use case without hitting MySQL INT UNSIGNED overflow.
 *
 * This system test will compare against the OneVisitorTwoVisitsWithCookieSupportTest system test
 * (OneVisitorTwoVisits_withCookieSupport* expected api responses) and expect the same API responses.
 *
 * @group SimulateAutoIncrementIntegerOverflowTest
 * @group Core
 */
class SimulateAutoIncrementIntegerOverflowTest extends SystemTestCase
{
    /** OneVisitorTwoVisits */
    public static $fixture = null; // initialized below class

    /**
     * @dataProvider getApiForTesting
     */
    public function testApi($api, $params)
    {
        $this->runApiTests($api, $params);
        $this->checkAutoIncrementIdsAreMoreThanFourBillion();
    }

    private function checkAutoIncrementIdsAreMoreThanFourBillion()
    {
        $fieldsThatShouldNotOverflow = array(
            'log_visit' => 'idvisit',
            'log_link_visit_action' => 'idlink_va',
        );
        $this->assertGreaterThan(4294967294, self::$fixture->maxUnsignedIntegerValue);

        foreach ($fieldsThatShouldNotOverflow as $table => $autoIncrementField) {
            $table = Common::prefixTable($table);
            $value = Db::fetchOne("SELECT MAX($autoIncrementField) FROM $table ");
            $this->assertGreaterThan(self::$fixture->maxUnsignedIntegerValue, $value, 'in ' . $table);
        }
    }

    public function getApiForTesting()
    {
        $apiToCall = array(
            'VisitTime', 'VisitsSummary', 'VisitorInterest', 'VisitFrequency', 'DevicesDetection',
            'UserCountry',
            'Provider', 'Goals', 'CustomVariables', 'CoreAdminHome', 'DevicePlugins',
            'Actions',  'Referrers',
        );

        return array(
            array($apiToCall, array(
                'idSite' => self::$fixture->idSite,
                'date' => self::$fixture->dateTime,
                'compareAgainst' => 'OneVisitorTwoVisits_withCookieSupport',
            )),
        );
    }

    public function provideContainerConfig()
    {
        return array(
            'Piwik\Config' => \Piwik\DI::decorate(function ($previous) {
                $general = $previous->General;
                $general['action_title_category_delimiter'] = "/";
                $previous->General = $general;
                return $previous;
            }),
        );
    }
}

SimulateAutoIncrementIntegerOverflowTest::$fixture = new OneVisitorTwoVisits();
SimulateAutoIncrementIntegerOverflowTest::$fixture->useThirdPartyCookies = true;
SimulateAutoIncrementIntegerOverflowTest::$fixture->useSiteSearch = true;
SimulateAutoIncrementIntegerOverflowTest::$fixture->simulateIntegerOverflow = true;