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
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\Fixtures;
use Piwik\Date;
use Piwik\Plugins\Goals\API;
use Piwik\Tracker\Visit;
use Piwik\Tests\Fixture;
use PiwikTracker;
use Exception;
/**
* Adds one site and tracks a couple visits using a custom visitor ID.
*/
class FewVisitsWithSetVisitorId extends Fixture
{
public $idSite = 1;
public $idGoal = 1;
public $dateTime = '2010-03-06 11:22:33';
const USER_ID_EXAMPLE_COM = 'email@example.com';
public function setUp()
{
$this->setUpWebsitesAndGoals();
$this->trackVisits_setVisitorId();
$this->trackVisits_setUserId();
// generate data for the period = week, month, year use cases
$this->trackVisits_oneWeekLater_setUserId();
}
public function tearDown()
{
// empty
}
private function setUpWebsitesAndGoals()
{
// tests run in UTC, the Tracker in UTC
if (!self::siteCreated($this->idSite)) {
self::createWebsite($this->dateTime);
}
if (!self::goalExists($this->idSite, $this->idGoal)) {
API::getInstance()->addGoal($this->idSite, 'triggered js', 'manually', '', '');
}
}
private function trackVisits_setVisitorId()
{
// total = 2 visitors, 3 page views
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
// First, some basic tests
$this->settingInvalidVisitorIdShouldThrow($t);
// We create VISITOR A
$t->setUrl('http://example.org/index.htm');
$t->setVisitorId('a13b7c5a62f72dea');
self::checkResponse($t->doTrackPageView('incredible title!'));
// VISITOR B: few minutes later, we trigger the same tracker but with a custom visitor ID,
// => this will create a new visit B
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.05)->getDatetime());
$t->setUrl('http://example.org/index2.htm');
$t->setVisitorId('f66bc315f2a01a79');
self::checkResponse($t->doTrackPageView('incredible title!'));
// This new visit B will have 2 page views
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(0.1)->getDatetime());
$t->setUrl('http://example.org/index3.htm');
self::checkResponse($t->doTrackPageView('incredible title!'));
}
private function trackVisits_setUserId()
{
$userId = self::USER_ID_EXAMPLE_COM;
// total = 2 visitors, 3 page views
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
// First, some basic tests
$this->settingInvalidUserIdShouldThrow($t);
// We create a visit with no User ID.
// When User ID will be set below, then it will UPDATE this visit here that starts without UserID
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(1.9)->getDatetime());
$t->setUrl('http://example.org/no-user-id-set-but-should-appear-in-user-id-visit');
self::checkResponse($t->doTrackPageView('no User Id set but it should appear in '. $userId .'!'));
// A NEW VISIT
// Setting both Visitor ID and User ID
// -> User ID takes precedence
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(2)->getDatetime());
$t->setUrl('http://example.org/index.htm');
// Set Visitor ID first.
$generatedVisitorId = '6ccebef4faef4969';
$t->setVisitorId($generatedVisitorId);
$this->assertEquals($generatedVisitorId, $t->getVisitorId());
// Set User ID
$t->setUserId($userId);
$this->assertEquals($userId, $t->getUserId());
// User ID takes precedence over any previously set Visitor ID
$hashUserId = $t->getUserIdHashed($userId);
$this->assertEquals($hashUserId, $t->getVisitorId());
// Track a pageview with this user id
self::checkResponse($t->doTrackPageView('incredible title!'));
// Track another pageview
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(2.1)->getDatetime());
self::checkResponse($t->doTrackPageView('second page'));
// A NEW VISIT WITH A SET USER ID
// Change User ID -> This will create a new visit
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(2.2)->getDatetime());
$t->setNewVisitorId();
$secondUserId = 'new-email@example.com';
$t->setUserId($secondUserId);
self::checkResponse($t->doTrackPageView('a new user id was set -> new visit'));
// A NEW VISIT BY THE SAME USER
// Few hours later, the same user ID comes in from a different place and computer
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(5)->getDatetime());
// Make sure the computer and IP look really different from previous visit
$t->setIp('67.51.31.21');
$t->setUserAgent("Mozilla/5.0 (Windows; U; Windows NT 5.1; en-GB; rv:1.9.2.6) Gecko/20100625 Firefox/3.6.6 (.NET CLR 3.5.30729)");
$t->setBrowserLanguage('fr');
$t->setUserId($secondUserId);
$t->setUrl('http://example.org/home');
self::checkResponse($t->doTrackPageView('same user id was set -> this is the same unique user'));
// Do not pass User ID in this request, it should still attribute to previous visit
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(5.1)->getDatetime());
self::checkResponse($t->doTrackPageView('second pageview - by this user id'));
// Request from a different computer not yet logged in, this should not be added to our User ID session
$t->setUserId(false);
// make sure the Id is not so random as to not fail the test
$t->randomVisitorId = '5e15b4d842cc294d';
$t->setIp('1.2.4.7');
$t->setUserAgent("New unique device");
self::checkResponse($t->doTrackPageView('pageview - should not be tracked by our user id but in a new visit'));
// User has now logged in so we measure her interactions to her User ID
$t->setUserId($secondUserId);
// Trigger a goal conversion
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(5.2)->getDatetime());
self::checkResponse($t->doTrackGoal(1));
// An ecommerce add to cart
// (helpful to test that &segment=userId==x will return all items purchased by a specific user ID
$t->setForceVisitDateTime(Date::factory($this->dateTime)->addHour(5.3)->getDatetime());
$t->setUrl('http://nsa.gov/buy/prism');
$t->addEcommerceItem('sku-007-PRISM', 'My secret spy tech', 'Surveillance', '10000000000');
$t->doTrackEcommerceCartUpdate(10000000000 + 500 /* add some for shipping PRISM */);
}
private function trackVisits_oneWeekLater_setUserId()
{
$oneWeekLater = Date::factory($this->dateTime)->addDay(8);
// Set User ID to a known user id
$t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
$t->setForceVisitDateTime($oneWeekLater->getDatetime());
$t->setUrl('http://example.org/index.htm');
$t->setUserId(self::USER_ID_EXAMPLE_COM);
self::checkResponse($t->doTrackPageView('Page view by ' . self::USER_ID_EXAMPLE_COM));
// Set a new User ID not set before
$t->setForceVisitDateTime($oneWeekLater->addHour(0.4)->getDatetime());
$t->setUrl('http://example.org/index.htm');
$userId = 'new-user-id@one-weeklater';
$t->setUserId($userId);
$t->setVisitorId('6ccebef4faef4969'); // this should be ignored and User ID prevail
self::checkResponse($t->doTrackPageView('A page view by ' . $userId));
$t->setForceVisitDateTime($oneWeekLater->addHour(0.8)->getDatetime());
}
private function settingInvalidVisitorIdShouldThrow(PiwikTracker $t)
{
try {
$t->setVisitorId('test');
$this->fail('should throw');
} catch (Exception $e) {
//OK
}
try {
$t->setVisitorId('61e8');
$this->fail('should throw');
} catch (Exception $e) {
//OK
}
try {
$t->setVisitorId('61e8cc2d51fea26dabcabcabc');
$this->fail('should throw');
} catch (Exception $e) {
//OK
}
}
private function settingInvalidUserIdShouldThrow(PiwikTracker $t)
{
try {
$t->setUserId('');
$this->fail('should throw');
} catch (Exception $e) {
//OK
}
}
}
|
