File size: 7,751 Bytes
bf8c0ce | 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 | <?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\Tests\Integration\Tracker;
use Piwik\Container\Container;
use Piwik\Plugin\RequestProcessors;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tracker;
use Piwik\Tracker\BotRequestProcessor;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Piwik\Tracker\Request;
use Piwik\Tracker\RequestProcessor;
use Piwik\Tracker\Visit\VisitProperties;
use Piwik\Version;
/**
* @group Core
* @group Tracker
* @group BotRequestHandling
*/
class BotRequestHandlingTest extends IntegrationTestCase
{
public static $eventsTriggered = [];
public function setUp(): void
{
parent::setUp();
Fixture::createWebsite('2025-05-05 20:00:00');
BotRequestHandlingTest::$eventsTriggered = [
'BotRequestProcessor' => [],
'RequestProcessor' => [],
];
}
/**
* @param string|int|array|null $recMode
* @dataProvider getTestModeData
*/
public function testVisitTrackingWithDefaultMode(string $ua, $recMode, array $expectedEvents): void
{
$tracker = new Tracker();
$request = new Request([
'idsite' => 1,
'url' => 'https://example.com/test',
'ua' => $ua,
'rec' => 1,
'recMode' => $recMode,
]);
$tracker->trackRequest($request);
self::assertEquals($expectedEvents, self::$eventsTriggered);
}
public function getTestModeData(): iterable
{
yield 'Visit tracked in default mode should be processed by RequestProcessor only' => [
'ua' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) RockMelt/0.9.58.494 Chrome/11.0.696.71 Safari/534.24',
'recMode' => null,
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [
'manipulateRequest',
'processRequestParams',
],
],
];
yield 'Bot tracked in default mode should be also processed by RequestProcessor only' => [
'ua' => 'Mozilla/5.0 (compatible; ChatGPT-User/1.0; +https://openai.com)',
'recMode' => '',
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [
'manipulateRequest',
'processRequestParams',
],
],
];
yield 'Visit tracked in bot mode should not be processed at all' => [
'ua' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) RockMelt/0.9.58.494 Chrome/11.0.696.71 Safari/534.24',
'recMode' => 1,
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [],
],
];
yield 'Bot tracked in bot mode should be processed by BotRequestProcessor only' => [
'ua' => 'Mozilla/5.0 (compatible; ChatGPT-User/1.0; +https://openai.com)',
'recMode' => '1',
'expectedEvents' => [
'BotRequestProcessor' => [
'manipulateRequest',
'handleRequest',
],
'RequestProcessor' => version_compare(Version::VERSION, '6.0.0-rc1', '<') ? [
'manipulateRequest', // currently still triggered for bc reasons
] : [],
],
];
yield 'Visit tracked in auto mode should be processed by RequestProcessor only' => [
'ua' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) RockMelt/0.9.58.494 Chrome/11.0.696.71 Safari/534.24',
'recMode' => 2,
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [
'manipulateRequest',
'processRequestParams',
],
],
];
yield 'Bot tracked in auto mode should be processed by BotRequestProcessor only' => [
'ua' => 'Mozilla/5.0 (compatible; ChatGPT-User/1.0; +https://openai.com)',
'recMode' => '2',
'expectedEvents' => [
'BotRequestProcessor' => [
'manipulateRequest',
'handleRequest',
],
'RequestProcessor' => version_compare(Version::VERSION, '6.0.0-rc1', '<') ? [
'manipulateRequest', // currently still triggered for bc reasons
] : [],
],
];
yield 'Visit tracked with invalid integer mode should not be processed' => [
'ua' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) RockMelt/0.9.58.494 Chrome/11.0.696.71 Safari/534.24',
'recMode' => '5',
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [],
],
];
yield 'Visit tracked with invalid array mode should not be processed' => [
'ua' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_7) AppleWebKit/534.24 (KHTML, like Gecko) RockMelt/0.9.58.494 Chrome/11.0.696.71 Safari/534.24',
'recMode' => ['bla'],
'expectedEvents' => [
'BotRequestProcessor' => [],
'RequestProcessor' => [],
],
];
}
public function provideContainerConfig()
{
return [
RequestProcessors::class => function (Container $c) {
return new class extends RequestProcessors {
public function getBotRequestProcessors(): array
{
return [
new class extends BotRequestProcessor {
public function manipulateRequest(Request $request): void
{
BotRequestHandlingTest::$eventsTriggered['BotRequestProcessor'][] = 'manipulateRequest';
}
public function handleRequest(Request $request): bool
{
BotRequestHandlingTest::$eventsTriggered['BotRequestProcessor'][] = 'handleRequest';
return false;
}
},
];
}
public function getRequestProcessors(): array
{
return [
new class extends RequestProcessor {
public function manipulateRequest(Request $request)
{
BotRequestHandlingTest::$eventsTriggered['RequestProcessor'][] = 'manipulateRequest';
}
public function processRequestParams(VisitProperties $visitProperties, Request $request)
{
BotRequestHandlingTest::$eventsTriggered['RequestProcessor'][] = 'processRequestParams';
return true; // abort to avoid further processing
}
},
];
}
};
},
];
}
}
|