Add feature flag

Author: caddoo

core/Tracker/Visit.php

@@ -19,6 +19,8 @@
 use Piwik\Plugin\Dimension\VisitDimension;
 use Piwik\Plugin\LogTablesProvider;
 use Piwik\Plugins\Actions\Tracker\ActionsRequestProcessor;
+use Piwik\Plugins\FeatureFlags\FeatureFlagManager;
+use Piwik\Plugins\FeatureFlags\FeatureFlags\UpdateVisitIdInLogTablesOnTrackingRequests;
 use Piwik\Plugins\UserCountry\Columns\Base;
 use Piwik\Tracker;
 use Piwik\Tracker\Visit\VisitProperties;
@@ -71,6 +73,11 @@ class Visit implements VisitInterface
      */
     protected $previousVisitProperties;
 
+    /**
+     * @var FeatureFlagManager
+     */
+    private $featureFlagManager;
+
     /**
      * @var ArchiveInvalidator
      */
@@ -91,6 +98,7 @@ public function __construct()
         $this->visitProperties = null;
         $this->userSettings = StaticContainer::get('Piwik\Tracker\Settings');
         $this->invalidator = StaticContainer::get('Piwik\Archive\ArchiveInvalidator');
+        $this->featureFlagManager = StaticContainer::get(FeatureFlagManager::class);
     }
 
     /**
@@ -435,9 +443,11 @@ protected function updateExistingVisit($valuesToUpdate)
 
 
         if (isset($valuesToUpdate['idvisitor'])) {
-            $this->updateIdVisitorAcrossLogTables($valuesToUpdate['idvisitor']);
 
-            Common::printDebug('Updating idvisitor across tables for idvisit = ' . $idVisit);
+            if ($this->featureFlagManager->isFeatureActive(UpdateVisitIdInLogTablesOnTrackingRequests::class)) {
+                $this->updateIdVisitorAcrossLogTables($valuesToUpdate['idvisitor']);
+                Common::printDebug('Updating idvisitor across tables for idvisit = ' . $idVisit);
+            }
 
             //For debug output below
             $valuesToUpdate['idvisitor'] = bin2hex($valuesToUpdate['idvisitor']);

plugins/FeatureFlags/FeatureFlags/UpdateVisitIdInLogTablesOnTrackingRequests.php

@@ -0,0 +1,24 @@
+<?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\Plugins\FeatureFlags\FeatureFlags;
+
+use Piwik\Plugins\FeatureFlags\FeatureFlagInterface;
+
+/**
+ * This will add additional load on tracking requests, it should result in more accurate reports.
+ * There is a risk of table locks, hence this feature being flagged for test purposes only.
+ */
+class UpdateVisitIdInLogTablesOnTrackingRequests implements FeatureFlagInterface
+{
+    public function getName(): string
+    {
+        return 'UpdateVisitIdInLogTablesOnTrackingRequests';
+    }
+}

tests/PHPUnit/Integration/Tracker/UserIdVisitorIdTest.php

@@ -11,8 +11,11 @@
 
 use Piwik\Common;
 use Piwik\Config;
+use Piwik\Container\StaticContainer;
 use Piwik\Date;
 use Piwik\Db;
+use Piwik\Plugins\FeatureFlags\FeatureFlagManager;
+use Piwik\Plugins\FeatureFlags\FeatureFlags\UpdateVisitIdInLogTablesOnTrackingRequests;
 use Piwik\Tests\Framework\Fixture;
 use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
 
@@ -40,6 +43,14 @@ public function setUp(): void
 
         $this->testEnv = static::$fixture->getTestEnvironment();
         $this->trackerEventTsIterator = Date::factory(self::FIRST_VISIT_TIME)->getTimestamp();
+
+        $mockFeatureFlagManager = $this->createMock(FeatureFlagManager::class);
+        $mockFeatureFlagManager
+            ->method('isFeatureActive')
+            ->with(UpdateVisitIdInLogTablesOnTrackingRequests::class)
+            ->willReturn(true);
+
+        StaticContainer::getContainer()->set(FeatureFlagManager::class, $mockFeatureFlagManager);
     }
 
     private function trackPageview(\MatomoTracker $tracker, $url)