File size: 5,402 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
210
211
212
213
214
<?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\Integration\Archive;

use Piwik\Archive;
use Piwik\Archive\ArchiveState;
use Piwik\Archive\ArchiveInvalidator;
use Piwik\Config;
use Piwik\DataAccess\Model;
use Piwik\DataTable;
use Piwik\Date;
use Piwik\Log\NullLogger;
use Piwik\Segment;
use Piwik\Tests\Fixtures\OneVisitorTwoVisits;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group ArchiveStateMetadataTest
 * @group Core
 */
class ArchiveStateMetadataTest extends IntegrationTestCase
{
    /**
     * @var OneVisitorTwoVisits
     */
    public static $fixture;

    /**
     * @var string
     */
    private $archiveDate;

    /**
     * @var Segment|null
     */
    private $archiveSegment;

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

    /**
     * @var ArchiveInvalidator
     */
    private $invalidator;

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

        $this->archiveDate = Date::factory(self::$fixture->dateTime)->toString();
        $this->archiveSite = self::$fixture->idSite;

        $this->invalidator = new ArchiveInvalidator(new Model(), new NullLogger());
    }

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

        Date::$now = null;
    }

    /**
     * @dataProvider getArchiveStateTestData
     *
     * @param array<string> $pluginsToInvalidate
     */
    public function testGetDataTableFromNumericReturnsArchiveStateInMetadata(
        int $nowTimestamp,
        ?string $segment,
        ?array $pluginsToInvalidate,
        string $expectedInitialArchiveState,
        string $expectedFinalArchiveState
    ): void {
        Date::$now = $nowTimestamp;

        if (null !== $segment) {
            $this->archiveSegment = new Segment($segment, [$this->archiveSite]);
        }

        $this->setUpInitialState($expectedInitialArchiveState);
        $this->invalidateArchives($pluginsToInvalidate);
        $this->disableArchiving();

        $dataTable = $this->getDataTable();

        self::assertSame(
            $expectedFinalArchiveState,
            $dataTable->getMetadata(DataTable::ARCHIVE_STATE_METADATA_NAME)
        );
    }

    /**
     * @return iterable<string, array>
     */
    public function getArchiveStateTestData(): iterable
    {
        $timestampToday = strtotime(self::$fixture->dateTime);
        $timestampTomorrow = $timestampToday + 86400;

        yield 'today, all ok' => [
            $timestampToday,
            null,
            null,
            ArchiveState::INCOMPLETE,
            ArchiveState::INCOMPLETE,
        ];

        yield 'yesterday, all ok' => [
            $timestampTomorrow,
            null,
            null,
            ArchiveState::COMPLETE,
            ArchiveState::COMPLETE,
        ];

        yield 'today, everything invalidated' => [
            $timestampToday,
            null,
            [],
            ArchiveState::INCOMPLETE,
            ArchiveState::INVALIDATED,
        ];

        yield 'yesterday, everything invalidated' => [
            $timestampTomorrow,
            null,
            [],
            ArchiveState::COMPLETE,
            ArchiveState::INVALIDATED,
        ];

        yield 'segmented, everything invalidated' => [
            $timestampTomorrow,
            'visitorType==new',
            [],
            ArchiveState::COMPLETE,
            ArchiveState::INVALIDATED,
        ];

        yield 'segmented, partially invalidated' => [
            $timestampTomorrow,
            'visitorType==new',
            ['Goals'],
            ArchiveState::COMPLETE,
            ArchiveState::INVALIDATED,
        ];
    }

    private function disableArchiving(): void
    {
        Config::getInstance()->General['enable_browser_archiving_triggering'] = 0;
        Config::getInstance()->General['browser_archiving_disabled_enforce'] = 1;
    }

    private function getDataTable(): DataTable
    {
        $archive = Archive::build(
            $this->archiveSite,
            'day',
            $this->archiveDate,
            null === $this->archiveSegment ? null : $this->archiveSegment->getString()
        );

        return $archive->getDataTableFromNumeric(['Goal_nb_conversions', 'Goals_nb_visits_converted', 'nb_visits']);
    }

    /**
     * @param array<string>|null $plugins
     */
    private function invalidateArchives(?array $plugins): void
    {
        if (null === $plugins) {
            return;
        }

        if ([] === $plugins) {
            // invalidate everything
            $plugins = [null];
        }

        foreach ($plugins as $plugin) {
            $this->invalidator->markArchivesAsInvalidated(
                [$this->archiveSite],
                [$this->archiveDate],
                'day',
                $this->archiveSegment,
                false,
                false,
                $plugin
            );
        }
    }

    private function setUpInitialState(string $expectedInitialArchiveState): void
    {
        $dataTable = $this->getDataTable();
        $archiveState = $dataTable->getMetadata(DataTable::ARCHIVE_STATE_METADATA_NAME);

        self::assertSame($expectedInitialArchiveState, $archiveState);
    }
}

ArchiveStateMetadataTest::$fixture = new OneVisitorTwoVisits();