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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\System;
use Piwik\Cache;
use Piwik\Config;
use Piwik\Plugins\Actions\ArchivingHelper;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\ManyVisitsWithMockLocationProvider;
/**
* Test Piwik's report limiting code. Make sure the datatable_archiving_maximum_rows_...
* config options limit the size of certain reports when archiving.
*
* @group Core
* @group BlobReportLimitingTest
*/
class BlobReportLimitingTest extends SystemTestCase
{
/**
* @var ManyVisitsWithMockLocationProvider
*/
public static $fixture = null; // initialized below class definition
public function setUp(): void
{
Cache::getTransientCache()->flushAll();
parent::setUp();
}
public function getApiForTesting()
{
$apiToCall = array(
'Actions.getPageUrls', 'Actions.getPageTitles', 'Actions.getDownloads', 'Actions.getOutlinks',
'Actions.getSiteSearchKeywords',
'CustomVariables.getCustomVariables',
'Referrers.getReferrerType', 'Referrers.getKeywords', 'Referrers.getSearchEngines',
'Referrers.getWebsites', 'Referrers.getAll', /* TODO 'Referrers.getCampaigns', */
'Resolution.getResolution', 'Resolution.getConfiguration', 'DevicesDetection.getOsVersions',
'DevicesDetection.getBrowserVersions',
'UserCountry.getRegion', 'UserCountry.getCity',
'UserId.getUsers', 'Events', 'Contents',
);
$ecommerceApi = array('Goals.getItemsSku', 'Goals.getItemsName', 'Goals.getItemsCategory');
return array(
array($apiToCall, array('idSite' => self::$fixture->idSite,
'date' => self::$fixture->dateTime,
'periods' => array('day'))),
array($ecommerceApi, array('idSite' => self::$fixture->idSite,
'date' => self::$fixture->nextDay,
'periods' => 'day')),
array('CustomDimensions.getCustomDimension',
array(
'idSite' => 1,
'date' => self::$fixture->dateTime,
'periods' => array('day'),
'otherRequestParameters' => array(
'idDimension' => self::$fixture->customDimensionId,
),
'testSuffix' => "dimension_". self::$fixture->customDimensionId,
),
),
array('CustomDimensions.getCustomDimension',
array(
'idSite' => 1,
'date' => self::$fixture->dateTime,
'periods' => array('day'),
'otherRequestParameters' => array(
'idDimension' => self::$fixture->actionCustomDimensionId,
),
'testSuffix' => "dimension_". self::$fixture->actionCustomDimensionId,
// ranking query doesn't guarantee order if the main metric values are the same so the label/segment can randomly change.
// in this test, we only care to check that the result is being limited/aggregated correctly, so we can remove these
// when comparing.
'xmlFieldsToRemove' => ['label', 'segment', 'url', 'exit_nb_visits', 'exit_rate', 'bounce_count', 'bounce_rate'],
),
),
['Events', [
'idSite' => 1,
'date' => '2015-02-03',
'period' => ['day'],
'testSuffix' => 'withNegOneLabel_',
]],
);
}
public function getRankingQueryDisabledApiForTesting()
{
$idSite = self::$fixture->idSite;
$dateTime = self::$fixture->dateTime;
return array(
array('Actions.getPageUrls', array('idSite' => $idSite,
'date' => $dateTime,
'periods' => array('day'))),
// TODO these system tests need to be moved to Provider plugin
/*
array('Provider.getProvider', array('idSite' => $idSite,
'date' => $dateTime,
'periods' => array('month'))),
array('Provider.getProvider', array('idSite' => $idSite,
'date' => $dateTime,
'periods' => array('month'),
'segment' => 'provider==comcast.net',
'testSuffix' => '_segment_provider')),
*/
// test getDownloads w/ period=range & flat=1
array('Actions.getDownloads', array('idSite' => $idSite,
'date' => '2010-01-02,2010-01-05',
'periods' => 'range',
'testSuffix' => '_rangeFlat',
'otherRequestParameters' => array(
'flat' => 1,
'expanded' => 0
))),
['Insights.getInsightsOverview', [
'idSite' => 1,
'date' => '2015-03-04',
'period' => ['day'],
]],
);
}
/**
* @dataProvider getApiForTesting
*/
public function testApi($api, $params)
{
self::setUpConfigOptions();
$this->runApiTests($api, $params);
}
/**
* @dataProvider getApiForTesting
*/
public function testApiWithFlattening($apiToCall, $params)
{
self::setUpConfigOptions();
if (empty($params['testSuffix'])) {
$params['testSuffix'] = '';
}
$params['testSuffix'] .= '_flattened';
if (empty($params['otherRequestParameters'])) {
$params['otherRequestParameters'] = array();
}
$params['otherRequestParameters']['flat'] = '1';
$this->runApiTests($apiToCall, $params);
}
public function testApiWithRankingQuery()
{
self::setUpConfigOptions();
// custom setup
self::deleteArchiveTables();
Config::getInstance()->General['archiving_ranking_query_row_limit'] = 3;
ArchivingHelper::reloadConfig();
foreach ($this->getApiForTesting() as $pair) {
list($apiToCall, $params) = $pair;
if (empty($params['testSuffix'])) {
$params['testSuffix'] = '';
}
$params['testSuffix'] .= '_rankingQuery';
$this->runApiTests($apiToCall, $params);
}
}
public function testApiWithRankingQueryDisabled()
{
self::deleteArchiveTables();
$generalConfig =& Config::getInstance()->General;
$generalConfig['datatable_archiving_maximum_rows_referrers'] = 500;
$generalConfig['datatable_archiving_maximum_rows_subtable_referrers'] = 500;
$generalConfig['datatable_archiving_maximum_rows_actions'] = 500;
$generalConfig['datatable_archiving_maximum_rows_subtable_actions'] = 500;
$generalConfig['datatable_archiving_maximum_rows_standard'] = 500;
$generalConfig['datatable_archiving_maximum_rows_custom_dimensions'] = 500;
$generalConfig['datatable_archiving_maximum_rows_subtable_custom_dimensions'] = 500;
$generalConfig['archiving_ranking_query_row_limit'] = 0;
$generalConfig['datatable_archiving_maximum_rows_site_search'] = 500;
$generalConfig['datatable_archiving_maximum_rows_userid_users'] = 500;
foreach ($this->getRankingQueryDisabledApiForTesting() as $pair) {
list($apiToCall, $params) = $pair;
if (empty($params['testSuffix'])) {
$params['testSuffix'] = '';
}
$params['testSuffix'] .= '_rankingQueryDisabled';
$this->runApiTests($apiToCall, $params);
}
}
public static function getOutputPrefix()
{
return 'reportLimiting';
}
protected static function setUpConfigOptions()
{
$generalConfig =& Config::getInstance()->General;
$generalConfig['datatable_archiving_maximum_rows_referers'] = 3;
$generalConfig['datatable_archiving_maximum_rows_subtable_referers'] = 2;
$generalConfig['datatable_archiving_maximum_rows_actions'] = 4;
$generalConfig['datatable_archiving_maximum_rows_custom_dimensions'] = 3;
$generalConfig['datatable_archiving_maximum_rows_subtable_custom_dimensions'] = 2;
$generalConfig['datatable_archiving_maximum_rows_subtable_actions'] = 2;
$generalConfig['datatable_archiving_maximum_rows_standard'] = 3;
$generalConfig['datatable_archiving_maximum_rows_userid_users'] = 3;
$generalConfig['datatable_archiving_maximum_rows_events'] = 3;
$generalConfig['datatable_archiving_maximum_rows_subtable_events'] = 2;
$generalConfig['archiving_ranking_query_row_limit'] = 50000;
// Should be more than the datatable_archiving_maximum_rows_actions as code will take the max of these two
$generalConfig['datatable_archiving_maximum_rows_site_search'] = 5;
}
}
BlobReportLimitingTest::$fixture = new ManyVisitsWithMockLocationProvider();
|
