File size: 8,923 Bytes
c938f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | <?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
declare(strict_types=1);
namespace Piwik\Plugins\BotTracking\tests\Integration;
use Piwik\Common;
use Piwik\Db;
use Piwik\Plugins\BotTracking\BotDetector;
use Piwik\Plugins\BotTracking\Dao\BotRequestsDao;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
/**
* @group BotTracking
* @group Plugins
*/
class TrackerTest extends IntegrationTestCase
{
public function setUp(): void
{
parent::setUp();
Fixture::createSuperUser();
Fixture::createWebsite('2014-02-04');
}
/**
* @dataProvider getBotUserAgents
*/
public function testAIChatbotIsTrackedCorrectly(string $userAgent, string $expectedAgent, string $expectedType): void
{
$t = Fixture::getTracker(1, '2025-02-02 12:00:00');
$t->setUserAgent($userAgent);
$t->setUrl('https://matomo.org/faq/123');
$t->setCustomTrackingParameter('recMode', '1');
Fixture::checkResponse($t->doTrackPageView(''));
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [1]);
self::assertCount(1, $records);
self::assertEquals($expectedAgent, $records[0]['bot_name']);
self::assertEquals($expectedType, $records[0]['bot_type']);
$tableName = Common::prefixTable('log_visit');
$sql = "SELECT COUNT(*) FROM `{$tableName}` WHERE idsite = ?";
self::assertEquals(0, Db::fetchOne($sql, [1]));
$tableName = Common::prefixTable('log_action');
$sql = "SELECT COUNT(*) FROM `{$tableName}`";
self::assertEquals(1, Db::fetchOne($sql));
}
/**
* @return array<array{0: string, 1: string, 2: string}>
*/
public function getBotUserAgents(): array
{
return [
['ChatGPT-User/1.0', 'ChatGPT-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['chatgpt-user/1.0', 'ChatGPT-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['CHATGPT-USER/1.0', 'ChatGPT-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['Mozilla/5.0 (compatible; ChatGPT-User/1.0)', 'ChatGPT-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['Mozilla/5.0 (compatible; ChatGPT-User/1.0; +https://openai.com)', 'ChatGPT-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['MistralAI-User/2.0', 'MistralAI-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['Gemini-Deep-Research/1.0', 'Gemini-Deep-Research', BotDetector::BOT_TYPE_AI_CHATBOT],
['Claude-User/3.0', 'Claude-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['Perplexity-User/1.0', 'Perplexity-User', BotDetector::BOT_TYPE_AI_CHATBOT],
['Google-NotebookLM/1.0', 'Google-NotebookLM', BotDetector::BOT_TYPE_AI_CHATBOT],
];
}
public function testActionIdsAreCorrectlyReused(): void
{
$t = Fixture::getTracker(1, '2025-02-02 12:00:00');
$t->setUserAgent('ChatGPT-User/1.0');
$t->setUrl('https://matomo.org/faq/123');
$t->setCustomTrackingParameter('recMode', '1');
Fixture::checkResponse($t->doTrackPageView(''));
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [1]);
self::assertCount(1, $records);
self::assertEquals('ChatGPT-User', $records[0]['bot_name']);
self::assertEquals(BotDetector::BOT_TYPE_AI_CHATBOT, $records[0]['bot_type']);
$tableName = Common::prefixTable('log_visit');
$sql = "SELECT COUNT(*) FROM `{$tableName}` WHERE idsite = ?";
self::assertEquals(0, Db::fetchOne($sql, [1]));
$tableName = Common::prefixTable('log_action');
$sql = "SELECT COUNT(*) FROM `{$tableName}`";
self::assertEquals(1, Db::fetchOne($sql));
// track another bot request to ensure now new action is created
$t = Fixture::getTracker(1, '2025-02-02 12:00:00');
$t->setUserAgent('Gemini-Deep-Research/1.0');
$t->setUrl('https://matomo.org/faq/123');
$t->setCustomTrackingParameter('recMode', '1');
Fixture::checkResponse($t->doTrackPageView(''));
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [1]);
self::assertCount(2, $records);
self::assertEquals('Gemini-Deep-Research', $records[1]['bot_name']);
self::assertEquals(BotDetector::BOT_TYPE_AI_CHATBOT, $records[1]['bot_type']);
$tableName = Common::prefixTable('log_visit');
$sql = "SELECT COUNT(*) FROM `{$tableName}` WHERE idsite = ?";
self::assertEquals(0, Db::fetchOne($sql, [1]));
$tableName = Common::prefixTable('log_action');
$sql = "SELECT COUNT(*) FROM `{$tableName}`";
self::assertEquals(1, Db::fetchOne($sql));
}
public function testVisitsAndBotsShareActions(): void
{
// track a normal visit
$t = Fixture::getTracker(1, '2025-02-02 12:00:00');
$t->setUrl('https://matomo.org/faq/123');
Fixture::checkResponse($t->doTrackPageView(''));
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [1]);
self::assertCount(0, $records);
$tableName = Common::prefixTable('log_visit');
$sql = "SELECT COUNT(*) FROM `{$tableName}` WHERE idsite = ?";
self::assertEquals(1, Db::fetchOne($sql, [1]));
$tableName = Common::prefixTable('log_action');
$sql = "SELECT COUNT(*) FROM `{$tableName}`";
self::assertEquals(1, Db::fetchOne($sql));
// track another bot request to ensure now new action is created
$t = Fixture::getTracker(1, '2025-02-02 12:00:00');
$t->setUserAgent('Gemini-Deep-Research/1.0');
$t->setUrl('https://matomo.org/faq/123');
$t->setCustomTrackingParameter('recMode', '1');
Fixture::checkResponse($t->doTrackPageView(''));
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [1]);
self::assertCount(1, $records);
self::assertEquals('Gemini-Deep-Research', $records[0]['bot_name']);
self::assertEquals(BotDetector::BOT_TYPE_AI_CHATBOT, $records[0]['bot_type']);
$tableName = Common::prefixTable('log_visit');
$sql = "SELECT COUNT(*) FROM `{$tableName}` WHERE idsite = ?";
self::assertEquals(1, Db::fetchOne($sql, [1]));
$tableName = Common::prefixTable('log_action');
$sql = "SELECT COUNT(*) FROM `{$tableName}`";
self::assertEquals(1, Db::fetchOne($sql));
}
public function testVisitsAndBotsShareActionsWhenQueryParametersAreExcluded(): void
{
$idSite = Fixture::createWebsite(
'2014-02-04',
$ecommerce = 0,
$siteName = false,
$siteUrl = false,
$siteSearch = 1,
$searchKeywordParameters = null,
$searchCategoryParameters = null,
$timezone = null,
$type = null,
$excludeUnknownUrls = 0,
$excludedParameters = 'excluded'
);
$url = 'https://matomo.org/faq/123?keep=1&excluded=secret';
// track a normal visit with the excluded parameter
$t = Fixture::getTracker($idSite, '2025-02-02 12:00:00');
$t->setUrl($url);
Fixture::checkResponse($t->doTrackPageView(''));
// track a bot request with the same URL
$t = Fixture::getTracker($idSite, '2025-02-02 12:00:00');
$t->setUserAgent('Gemini-Deep-Research/1.0');
$t->setUrl($url);
$t->setCustomTrackingParameter('recMode', '1');
Fixture::checkResponse($t->doTrackPageView(''));
// the bot request must store the same cleaned URL the normal visit stored,
// so both resolve to a single shared action
$tableName = BotRequestsDao::getPrefixedTableName();
$idActionUrl = Db::fetchOne("SELECT idaction_url FROM `{$tableName}` WHERE idsite = ?", [$idSite]);
$actionTable = Common::prefixTable('log_action');
$name = Db::fetchOne("SELECT name FROM `{$actionTable}` WHERE idaction = ?", [$idActionUrl]);
self::assertEquals('matomo.org/faq/123?keep=1', $name);
$count = Db::fetchOne("SELECT COUNT(*) FROM `{$actionTable}` WHERE name = ? AND type = ?", [
'matomo.org/faq/123?keep=1',
\Piwik\Tracker\Action::TYPE_PAGE_URL,
]);
self::assertEquals(1, $count);
}
}
|