File: BotRequestsDaoTest.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (141 lines) | stat: -rw-r--r-- 4,396 bytes parent folder | download
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
<?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\Dao;

use Piwik\Date;
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 BotRequestsDao
 * @group Plugins
 */
class BotRequestsDaoTest extends IntegrationTestCase
{
    /**
     * @var BotRequestsDao
     */
    private $dao;

    /**
     * @var int
     */
    private $idSite;

    public function setUp(): void
    {
        parent::setUp();

        $this->idSite = Fixture::createWebsite('2025-01-01 00:00:00');
        $this->dao    = new BotRequestsDao();
    }

    public function testGetTableName(): void
    {
        $tableName = BotRequestsDao::getTableName();
        self::assertEquals('log_bot_request', $tableName);

        $tableName = BotRequestsDao::getPrefixedTableName();
        self::assertStringContainsString('log_bot_request', $tableName);
    }

    public function testInsertCreatesRecord(): void
    {
        $data = [
            'idsite'              => $this->idSite,
            'server_time'         => '2025-10-28 12:00:00',
            'idaction_url'        => 123,
            'bot_name'            => 'ChatGPT-User',
            'bot_type'            => BotDetector::BOT_TYPE_AI_CHATBOT,
            'http_status_code'    => 200,
            'response_size_bytes' => 2048,
            'response_time_ms'    => 125,
            'source'              => 'cloudflare',
        ];

        $idRequest = $this->dao->insert($data);

        self::assertGreaterThan(0, $idRequest);

        $tableName = BotRequestsDao::getPrefixedTableName();
        $sql       = "SELECT * FROM `{$tableName}` WHERE idrequest = ?";
        $record    = Db::fetchRow($sql, [$idRequest]);

        self::assertNotEmpty($record);
        self::assertEquals($this->idSite, $record['idsite']);
        self::assertEquals('ChatGPT-User', $record['bot_name']);
        self::assertEquals(BotDetector::BOT_TYPE_AI_CHATBOT, $record['bot_type']);
        self::assertEquals(200, $record['http_status_code']);
    }

    public function testInsertWithNullOptionalFields(): void
    {
        $data = [
            'idsite'      => $this->idSite,
            'server_time' => '2025-10-28 12:00:00',
            'bot_name'    => 'Claude-User',
            'bot_type'    => BotDetector::BOT_TYPE_AI_CHATBOT,
        ];

        $idRequest = $this->dao->insert($data);

        self::assertGreaterThan(0, $idRequest);

        $tableName = BotRequestsDao::getPrefixedTableName();
        $sql       = "SELECT * FROM `{$tableName}` WHERE idrequest = ?";
        $record    = Db::fetchRow($sql, [$idRequest]);

        self::assertNull($record['idaction_url']);
        self::assertNull($record['http_status_code']);
        self::assertNull($record['response_size_bytes']);
        self::assertNull($record['response_time_ms']);
        self::assertNull($record['source']);
    }

    public function testDeleteOldRecordsDeletesRecordsBeforeDate(): void
    {
        $this->insertTestRecord('2025-10-20 10:00:00', 'Old-Bot-1');
        $this->insertTestRecord('2025-10-25 10:00:00', 'Old-Bot-2');
        $this->insertTestRecord('2025-10-28 10:00:00', 'Recent-Bot');

        $deleteBeforeDate = Date::factory('2025-10-27 00:00:00');
        $deletedCount     = $this->dao->deleteOldRecords($deleteBeforeDate);

        self::assertEquals(2, $deletedCount);

        $tableName      = BotRequestsDao::getPrefixedTableName();
        $sql            = "SELECT COUNT(*) as count FROM `{$tableName}` WHERE idsite = ?";
        $remainingCount = Db::fetchOne($sql, [$this->idSite]);

        self::assertEquals(1, $remainingCount);
    }

    private function insertTestRecord($serverTime, $botName, $idSite = null): int
    {
        if ($idSite === null) {
            $idSite = $this->idSite;
        }

        $data = [
            'idsite'      => $idSite,
            'server_time' => $serverTime,
            'bot_name'    => $botName,
            'bot_type'    => BotDetector::BOT_TYPE_AI_CHATBOT,
        ];

        return $this->dao->insert($data);
    }
}