From b0553730a95c5b6cd7408c5834ba8acd029c7375 Mon Sep 17 00:00:00 2001 From: Thomas Steur Date: Thu, 9 Jul 2020 10:22:20 +1200 Subject: By default userId should overwrite the visitorId (#16124) * By default userId should overwrite the visitorId * handle new visits * Update Request.php * fix some tests * fix tests * fix more tests * add more tests, fix tests * Update global.ini.php * add better tests * update screenshot * update test file Co-authored-by: diosmosis --- .../tests/Fixtures/OverwriteUserIdFixture.php | 66 ++++++++++++++++ plugins/UserId/tests/System/ApiTest.php | 1 + .../UserId/tests/System/OverwriteUserIdTest.php | 90 ++++++++++++++++++++++ .../expected/test___UserId.getUsers_range.xml | 12 +-- .../test_ascSortOrder__UserId.getUsers_range.xml | 12 +-- .../expected/test_limit__UserId.getUsers_range.xml | 6 +- ...riteUserId__Live.getLastVisitsDetails_range.xml | 39 ++++++++++ .../test_overwriteUserId__UserId.getUsers_day.xml | 42 ++++++++++ ...test_overwriteUserId__UserId.getUsers_range.xml | 42 ++++++++++ .../test_searchByUserId__UserId.getUsers_range.xml | 6 +- 10 files changed, 298 insertions(+), 18 deletions(-) create mode 100644 plugins/UserId/tests/Fixtures/OverwriteUserIdFixture.php create mode 100644 plugins/UserId/tests/System/OverwriteUserIdTest.php create mode 100644 plugins/UserId/tests/System/expected/test_overwriteUserId__Live.getLastVisitsDetails_range.xml create mode 100644 plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_day.xml create mode 100644 plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_range.xml (limited to 'plugins/UserId') diff --git a/plugins/UserId/tests/Fixtures/OverwriteUserIdFixture.php b/plugins/UserId/tests/Fixtures/OverwriteUserIdFixture.php new file mode 100644 index 0000000000..5c1a16650d --- /dev/null +++ b/plugins/UserId/tests/Fixtures/OverwriteUserIdFixture.php @@ -0,0 +1,66 @@ +dateTime); + } + + $this->trackVisits(); + } + + private function trackVisits() + { + $testEnv = $this->getTestEnvironment(); + $testEnv->overrideConfig('Tracker', 'enable_userid_overwrites_visitorid', 0); + $testEnv->save(); + + $t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true); + $t->setTokenAuth(self::getTokenAuth()); + $t->enableBulkTracking(); + + foreach (array('user1', 'user2', 'user3') as $key => $userId) { + for ($numVisits = 0; $numVisits < 2; $numVisits++) { + $t->setUserId($userId); + $t->setIp('10.10.10.' . ($key+1) . $numVisits); + // each time we have a different visitorId and it should create many unique visitors and not just a unique + // visitor per user. We don't force a new visit so this should create multiple visits each time even though + // visitorId is always the same + // If userId was to overwrite the visitorId then we would only see 1 visit for each visitor, but here we see + // multiple visits since the visitorId always changes even though userId stays the same + $t->setVisitorId(substr(md5($numVisits.$key.$userId), 0, 16)); + $t->setUrl('http://example.org/my/dir/page' . $numVisits); + + $visitDateTime = Date::factory($this->dateTime)->addPeriod($numVisits, 'minute')->getDatetime(); + $t->setForceVisitDateTime($visitDateTime); + + self::assertTrue($t->doTrackPageView('incredible title ' . ($numVisits % 3))); + } + } + + self::checkBulkTrackingResponse($t->doBulkTrack()); + + $testEnv->overrideConfig('Tracker', 'enable_userid_overwrites_visitorid', 1); + $testEnv->save(); + } +} \ No newline at end of file diff --git a/plugins/UserId/tests/System/ApiTest.php b/plugins/UserId/tests/System/ApiTest.php index 82f1079d71..3d626944f1 100644 --- a/plugins/UserId/tests/System/ApiTest.php +++ b/plugins/UserId/tests/System/ApiTest.php @@ -8,6 +8,7 @@ namespace Piwik\Plugins\UserId\tests\System; +use Piwik\Config; use Piwik\Plugins\UserId\tests\Fixtures\TrackFewVisitsAndCreateUsers; use Piwik\Tests\Framework\TestCase\SystemTestCase; diff --git a/plugins/UserId/tests/System/OverwriteUserIdTest.php b/plugins/UserId/tests/System/OverwriteUserIdTest.php new file mode 100644 index 0000000000..6b018d3749 --- /dev/null +++ b/plugins/UserId/tests/System/OverwriteUserIdTest.php @@ -0,0 +1,90 @@ +runApiTests($api, $params); + } + + public function getApiForTesting() + { + $api = 'UserId.getUsers'; + $startDate = substr(self::$fixture->dateTime, 0, 10); + $endDate = date('Y-m-d', strtotime($startDate) + 3600*24*365); + + $apiToTest = array(); + $apiToTest[] = array( + $api, + array( + 'date' => $startDate, + 'periods' => array('day'), + 'idSite' => 1, + 'testSuffix' => '' + ) + ); + $apiToTest[] = array( + $api, + array( + 'date' => "$startDate,$endDate", + 'periods' => array('range'), + 'idSite' => 1, + 'testSuffix' => '' + ) + ); + + // we expext to always see 1 action only per visitor as visitorId changes every time ... + // we also expect a new visit to be created even though userId stays the same + $apiToTest[] = array( + 'Live.getLastVisitsDetails', + array( + 'date' => "$startDate,$endDate", + 'periods' => array('range'), + 'idSite' => 1, + 'testSuffix' => '', + 'otherRequestParameters' => array('doNotFetchActions' => '1', 'showColumns' => 'idVisit,userId,visitIp,actions'), + ) + ); + + return $apiToTest; + } + + public static function getOutputPrefix() + { + return 'overwriteUserId'; + } + + public static function getPathToTestDirectory() + { + return dirname(__FILE__); + } + +} + +OverwriteUserIdTest::$fixture = new OverwriteUserIdFixture(); \ No newline at end of file diff --git a/plugins/UserId/tests/System/expected/test___UserId.getUsers_range.xml b/plugins/UserId/tests/System/expected/test___UserId.getUsers_range.xml index fc8e450e2e..9ee518b4c3 100644 --- a/plugins/UserId/tests/System/expected/test___UserId.getUsers_range.xml +++ b/plugins/UserId/tests/System/expected/test___UserId.getUsers_range.xml @@ -4,9 +4,9 @@ 31 44 - 3 - 12 - 19 + 4 + 11 + 20 0 30 30 @@ -17,9 +17,9 @@ 21 29 - 2 - 8 - 13 + 3 + 7 + 14 0 20 20 diff --git a/plugins/UserId/tests/System/expected/test_ascSortOrder__UserId.getUsers_range.xml b/plugins/UserId/tests/System/expected/test_ascSortOrder__UserId.getUsers_range.xml index 4c4facb17c..07a49c9db5 100644 --- a/plugins/UserId/tests/System/expected/test_ascSortOrder__UserId.getUsers_range.xml +++ b/plugins/UserId/tests/System/expected/test_ascSortOrder__UserId.getUsers_range.xml @@ -17,9 +17,9 @@ 21 29 - 2 - 8 - 13 + 3 + 7 + 14 0 20 20 @@ -30,9 +30,9 @@ 31 44 - 3 - 12 - 19 + 4 + 11 + 20 0 30 30 diff --git a/plugins/UserId/tests/System/expected/test_limit__UserId.getUsers_range.xml b/plugins/UserId/tests/System/expected/test_limit__UserId.getUsers_range.xml index 0ebc46bfd4..425e57694a 100644 --- a/plugins/UserId/tests/System/expected/test_limit__UserId.getUsers_range.xml +++ b/plugins/UserId/tests/System/expected/test_limit__UserId.getUsers_range.xml @@ -4,9 +4,9 @@ 21 29 - 2 - 8 - 13 + 3 + 7 + 14 0 20 20 diff --git a/plugins/UserId/tests/System/expected/test_overwriteUserId__Live.getLastVisitsDetails_range.xml b/plugins/UserId/tests/System/expected/test_overwriteUserId__Live.getLastVisitsDetails_range.xml new file mode 100644 index 0000000000..dbec744212 --- /dev/null +++ b/plugins/UserId/tests/System/expected/test_overwriteUserId__Live.getLastVisitsDetails_range.xml @@ -0,0 +1,39 @@ + + + + 2 + 10.10.10.11 + user1 + 1 + + + 4 + 10.10.10.21 + user2 + 1 + + + 6 + 10.10.10.31 + user3 + 1 + + + 1 + 10.10.10.10 + user1 + 1 + + + 3 + 10.10.10.20 + user2 + 1 + + + 5 + 10.10.10.30 + user3 + 1 + + \ No newline at end of file diff --git a/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_day.xml b/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_day.xml new file mode 100644 index 0000000000..2d752ccc15 --- /dev/null +++ b/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_day.xml @@ -0,0 +1,42 @@ + + + + + 2 + 2 + 2 + 1 + 1 + 0 + 2 + 0 + + userId==user1 + + + + 2 + 2 + 2 + 1 + 1 + 0 + 2 + 0 + + userId==user2 + + + + 2 + 2 + 2 + 1 + 1 + 0 + 2 + 0 + + userId==user3 + + \ No newline at end of file diff --git a/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_range.xml b/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_range.xml new file mode 100644 index 0000000000..2839b1ff17 --- /dev/null +++ b/plugins/UserId/tests/System/expected/test_overwriteUserId__UserId.getUsers_range.xml @@ -0,0 +1,42 @@ + + + + + 2 + 2 + 1 + 0 + 2 + 0 + 2 + 1 + + userId==user1 + + + + 2 + 2 + 1 + 0 + 2 + 0 + 2 + 1 + + userId==user2 + + + + 2 + 2 + 1 + 0 + 2 + 0 + 2 + 1 + + userId==user3 + + \ No newline at end of file diff --git a/plugins/UserId/tests/System/expected/test_searchByUserId__UserId.getUsers_range.xml b/plugins/UserId/tests/System/expected/test_searchByUserId__UserId.getUsers_range.xml index 14cd163444..2f4630730a 100644 --- a/plugins/UserId/tests/System/expected/test_searchByUserId__UserId.getUsers_range.xml +++ b/plugins/UserId/tests/System/expected/test_searchByUserId__UserId.getUsers_range.xml @@ -4,9 +4,9 @@ 21 29 - 2 - 8 - 13 + 3 + 7 + 14 0 20 20 -- cgit v1.2.3